精华内容
下载资源
问答
  • 华为c语言编程规范pdf
    2021-05-21 08:11:52

    目 录

    1 排版 6

    2 注释 11

    3 标识符命名 18

    4 可读性 20

    5 变量、结构 22

    6 函数、过程 28

    7 可测性 36

    8 程序效率 40

    9 质量保证 44

    10 代码编辑、编译、审查 50

    11 代码测试、维护 52

    12 宏 53

    软件编程规范总则 1 排版

    1 排版

    11-1:程序块要采用缩进风格编写,缩进的空格数为4个。

    说明:对于由开发工具自动生成的代码可以有不一致。

    11-2:相对独立的程序块之间、变量说明之后必须加空行。

    示例:如下例子不符合规范。

    if (!valid_ni(ni))

    {

    ... // program code

    }

    repssn_ind = ssn_data[index].repssn_index;

    repssn_ni = ssn_data[index].ni;

    应如下书写

    if (!valid_ni(ni))

    {

    ... // program code

    }

    repssn_ind = ssn_data[index].repssn_index;

    repssn_ni = ssn_data[index].ni;

    11-3:较长的语句(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,

    操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。

    示例:

    perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN

    + STAT_SIZE_PER_FRAM * sizeof( _UL );

    act_task_table[frame_id * STAT_TASK_CHECK_NUMBER + index].occupied

    = stat_poi[index].occupied;

    act_task_table[taskno].duration_true_or_false

    = SYS_get_sccp_statistic_state( stat_item );

    report_or_not_flag = ((taskno < MAX_ACT_TA

    更多相关内容
  • 华为C语言编程规范 高清PDF版 内容可复制
  • 在公司已有编码规范的指导下,审慎地编排代码以使代码尽可能清晰,是一项非常重要的技能。 如果重构/ / 修改其他风格的代码时,比较明智的做法是根据 现有 代码 的 现有风格继续编写代码,或者使用格式转换工具进行...
  • 华为C语言编程规范
  • 华为的代码规范C语言版,适合嵌入式行业的工程师
  • 华为C语言编程规范[汇编].pdf
  • 华为公司 C/C++ 编程规范,可以参考规范自己代码,早日进入大厂
  • 华为C语言编程规范总则,华为C语言编程规范总则,华为C语言编程规范总则。
  • C语言规范
  • 华为C语言编程规范总则
  • 华为公司 C/C++ 编程规范,可以参考规范自己代码,早日进入大厂
  • 华为技术有限公司内部技术规范。 本规范制定了编写C语言程序的基本原则、规则和建议。从代码的清晰、简洁、可测试、安全、程序效率、可移植各个方面对C语言编程作出了具体指导。
  • 华为C语言编程规范(整理)

    万次阅读 多人点赞 2018-01-26 23:07:12
    对于C语言来说,头文件的设计体现了大部分的系统设计。 原则1.1 头文件中适合放置接口的声明,不适合放置实现。 说明:头文件是模块(Module)或单元(Unit)的对外接口。头文件中应放置对外部的声明,如对外提供的...

    总体原则
    1、清晰第一
    2、简洁为美
    3、选择合适的风格,与代码原有风格保持一致

    1 头文件

    对于C语言来说,头文件的设计体现了大部分的系统设计。
    原则1.1 头文件中适合放置接口的声明,不适合放置实现。
    说明:头文件是模块(Module)或单元(Unit)的对外接口。头文件中应放置对外部的声明,如对外提供的函数声明、宏定义、类型定义等。

    原则1.2 头文件应当职责单一。
    说明:头文件过于复杂,依赖过于复杂是导致编译时间过长的主要原因。很多现有代码中头文件过大,职责过多,再加上循环依赖的问题,可能导致为了在.c中使用一个宏,而包含十几个头文件。

    原则1.3 头文件应向稳定的方向包含。
    说明:头文件的包含关系是一种依赖,一般来说,应当让不稳定的模块依赖稳定的模块,从而当不稳定的模块发生变化时,不会影响(编译)稳定的模块。
    产品依赖于平台,平台依赖于标准库。
    除了不稳定的模块依赖于稳定的模块外,更好的方式是两个模块共同依赖于接口。

    规则1.1 每一个.c文件应有一个同名.h文件,用于声明需要对外公开的接口。
    说明:如果一个.c文件不需要对外公布任何接口,则其就不应当存在,除非它是程序的入口,如main函数所在的文件。

    规则1.2 禁止头文件循环依赖。
    说明:头文件循环依赖,指a.h包含b.h,b.h包含c.h,c.h包含a.h之类导致任何一个头文件修改,都导致所有包含了a.h/b.h/c.h的代码全部重新编译一遍。而如果是单向依赖,如a.h包含b.h,b.h包含c.h,而c.h不包含任何头文件,则修改a.h不会导致包含了b.h/c.h的源代码重新编译。

    规则1.3 .c/.h文件禁止包含用不到的头文件。
    说明:很多系统中头文件包含关系复杂,开发人员为了省事起见,可能不会去一一钻研,直接包含一切想到的头文件,甚至有些产品干脆发布了一个god.h,其中包含了所有头文件,然后发布给各个项目组使用,这种只图一时省事的做法,导致整个系统的编译时间进一步恶化,并对后来人的维护造成了巨大的麻烦。

    规则1.4 头文件应当自包含。
    说明:简单的说,自包含就是任意一个头文件均可独立编译。如果一个文件包含某个头文件,还要包含另外一个头文件才能工作的话,就会增加交流障碍,给这个头文件的用户增添不必要的负担。

    规则1.5 总是编写内部#include保护符(#define 保护)。
    说明:多次包含一个头文件可以通过认真的设计来避免。如果不能做到这一点,就需要采取阻止头文件内容被包含多于一次的机制。

    规则1.6 禁止在头文件中定义变量。
    说明:在头文件中定义变量,将会由于头文件被其他.c文件包含而导致变量重复定义。

    规则1.7 只能通过包含头文件的方式使用其他.c提供的接口,禁止在.c中通过extern的方式使用外部函数接口、变量。
    说明:若a.c使用了b.c定义的foo()函数,则应当在b.h中声明extern int foo(int input);并在a.c中通过#include <b.h>来使用foo。禁止通过在a.c中直接写extern int foo(int input);来使用foo,后面这种写法容易在foo改变时可能导致声明和定义不一致。

    规则1.8 禁止在extern "C"中包含头文件。
    说明:在extern "C"中包含头文件,会导致extern "C"嵌套,Visual Studio对extern "C"嵌套层次有限制,嵌套层次太多会编译错误。

    建议1.1 一个模块通常包含多个.c文件,建议放在同一个目录下,目录名即为模块名。为方便外部使用者,建议每一个模块提供一个.h,文件名为目录名。
    说明:需要注意的是,这个.h并不是简单的包含所有内部的.h,它是为了模块使用者的方便,对外整体提供的模块接口。

    建议1.2 如果一个模块包含多个子模块,则建议每一个子模块提供一个对外的.h,文件名为子模块名。
    说明:降低接口使用者的编写难度。

    建议1.3 头文件不要使用非习惯用法的扩展名,如.inc。
    说明:目前很多产品中使用了.inc作为头文件扩展名,这不符合c语言的习惯用法。在使用.inc作为头文件扩展名的产品,习惯上用于标识此头文件为私有头文件。但是从产品的实际代码来看,这一条并没有被遵守,一个.inc文件被多个.c包含比比皆是。本规范不提倡将私有定义单独放在头文件中。

    建议1.4 同一产品统一包含头文件排列方式。
    说明:常见的包含头文件排列方式:功能块排序、文件名升序、稳定度排序。

    2 函数

    函数设计的精髓:编写整洁函数,同时把代码有效组织起来。
    原则2.1 一个函数仅完成一件功能。
    说明:一个函数实现多个功能给开发、使用、维护都带来很大的困难。

    原则2.2 重复代码应该尽可能提炼成函数。
    说明:重复代码提炼成函数可以带来维护成本的降低。

    规则2.1 避免函数过长,新增函数不超过50行(非空非注释行)。
    说明:本规则仅对新增函数做要求,对已有函数修改时,建议不增加代码行。

    规则2.2 避免函数的代码块嵌套过深,新增函数的代码块嵌套不超过4层。
    说明:本规则仅对新增函数做要求,对已有的代码建议不增加嵌套层次。

    规则2.3 可重入函数应避免使用共享变量;若需要使用,则应通过互斥手段(关中断、信号量)对其加以保护。
    说明:可重入函数是指可能被多个任务并发调用的函数。在多任务操作系统中,函数具有可重入性是多个任务可以共用此函数的必要条件。共享变量指的全局变量和static变量。

    规则2.4 对参数的合法性检查,由调用者负责还是由接口函数负责,应在项目组/模块内应统一规定。缺省由调用者负责。
    说明:对于模块间接口函数的参数的合法性检查这一问题,往往有两个极端现象,即:要么是调用者和被调用者对参数均不作合法性检查,结果就遗漏了合法性检查这一必要的处理过程,造成问题隐患;要么就是调用者和被调用者均对参数进行合法性检查,这种情况虽不会造成问题,但产生了冗余代码,降低了效率。

    规则2.5 对函数的错误返回码要全面处理。
    说明:一个函数(标准库中的函数/第三方库函数/用户定义的函数)能够提供一些指示错误发生的方法。这可以通过使用错误标记、特殊的返回数据或者其他手段,不管什么时候函数提供了这样的机制,调用程序应该在函数返回时立刻检查错误指示。

    规则2.6 设计高扇入,合理扇出(小于7)的函数。
    说明:扇出是指一个函数直接调用(控制)其它函数的数目,而扇入是指有多少上级函数调用它。

    规则2.7 废弃代码(没有被调用的函数和变量)要及时清除。
    说明:程序中的废弃代码不仅占用额外的空间,而且还常常影响程序的功能与性能,很可能给程序的测试、维护等造成不必要的麻烦。

    建议2.1 函数不变参数使用const。
    说明:不变的值更易于理解/跟踪和分析,把const作为默认选项,在编译时会对其进行检查,使代码更牢固/更安全。

    建议2.2 函数应避免使用全局变量、静态局部变量和I/O操作,不可避免的地方应集中使用。
    说明:带有内部“存储器”的函数的功能可能是不可预测的,因为它的输出可能取决于内部存储器(如某标记)的状态。这样的函数既不易于理解又不利于测试和维护。在C语言中,函数的static局部变量是函数的内部存储器,有可能使函数的功能不可预测,然而,当某函数的返回值为指针类型时,则必须是static的局部变量的地址作为返回值,若为auto类,则返回为错针。

    建议2.3 检查函数所有非参数输入的有效性,如数据文件、公共变量等。
    说明:函数的输入主要有两种:一种是参数输入;另一种是全局变量、数据文件的输入,即非参数输入。函数在使用输入参数之前,应进行有效性检查。

    建议2.4 函数的参数个数不超过5个。
    说明:函数的参数过多,会使得该函数易于受外部(其他部分的代码)变化的影响,从而影响维护工作。函数的参数过多同时也会增大测试的工作量。

    建议2.5 除打印类函数外,不要使用可变长参函数。
    说明:可变长参函数的处理过程比较复杂容易引入错误,而且性能也比较低,使用过多的可变长参函数将导致函数的维护难度大大增加。

    建议2.6 在源文件范围内声明和定义的所有函数,除非外部可见,否则应该增加static关键字。
    说明:如果一个函数只是在同一文件中的其他地方调用,那么就用static声明。使用static确保只是在声明它的文件中是可见的,并且避免了和其他文件或库中的相同标识符发生混淆的可能性。

    3 标识符命名与定义

    unix like风格:单词用小写字母,每个单词直接用下划线“_”分割。
    Windows风格:大小写字母混用,单词连在一起,每个单词首字母大写。
    原则3.1 标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解。
    说明:尽可能给出描述性名称,不要节约空间,让别人很快理解你的代码更重要。

    原则3.2 除了常见的通用缩写以外,不使用单词缩写,不得使用汉语拼音。
    说明:较短的单词可通过去掉“元音”形成缩写,较长的单词可取单词的头几个字母形成缩写,一些
    单词有大家公认的缩写,常用单词的缩写必须统一。协议中的单词的缩写与协议保持一致。对于某个

    规则3.1 产品/项目组内部应保持统一的命名风格。
    说明:Unix like和windows like风格均有其拥趸,产品应根据自己的部署平台,选择其中一种,并在产品内部保持一致。

    规则3.2 全局变量应增加“g_”前缀。

    规则3.3 静态变量应增加“s_”前缀。
    说明:增加g前缀或者s前缀,原因如下:首先,全局变量十分危险,通过前缀使得全局变量更加醒目,促使开发人员对这些变量的使用更加小心。其次,从根本上说,应当尽量不使用全局变量,增加g_和s_前缀,会使得全局变量的名字显得很丑陋,从而促使开发人员尽量少使用全局变量。

    规则3.4 禁止使用单字节命名变量,但允许定义i、j、k作为局部循环变量。

    规则3.5 对于数值或者字符串等等常量的定义,建议采用全大写字母,单词之间加下划线„_‟的方式命名(枚举同样建议使用此方式定义)。

    规则3.6 除了头文件或编译开关等特殊标识定义,宏定义不能使用下划线„_‟开头和结尾。
    说明:一般来说,‟_‟开头、结尾的宏都是一些内部的定义,

    建议3.1 用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。

    建议3.2 尽量避免名字中出现数字编号,除非逻辑上的确需要编号。

    建议3.3 标识符前不应添加模块、项目、产品、部门的名称作为前缀。
    说明:很多已有代码中已经习惯在文件名中增加模块名,这种写法类似匈牙利命名法,导致文件名不
    可读,,不利于维护和移植。

    建议3.4 平台/驱动等适配代码的标识符命名风格保持和平台/驱动一致。
    说明:涉及到外购芯片以及配套的驱动,这部分的代码变动(包括为产品做适配的新增代码),应该
    保持原有的风格。

    建议3.5 重构/修改部分代码时,应保持和原有代码的命名风格一致。
    说明:根据源代码现有的风格继续编写代码,有利于保持总体一致。

    建议3.6 文件命名统一采用小写字符。
    说明:因为不同系统对文件名大小写处理会不同(如MS的DOS、Windows系统不区分大小写,但是Linux
    系统则区分),所以代码文件命名建议统一采用全小写字母命名。

    建议3.7 不建议使用匈牙利命名法。
    说明:变量命名需要说明的是变量的含义,而不是变量的类型。在变量命名前增加类型说明,反而降低了变量的可读性;更麻烦的问题是,如果修改了变量的类型定义,那么所有使用该变量的地方都需要修改。

    建议3.8 使用名词或者形容词+名词方式命名变量。

    建议3.9 函数命名应以函数要执行的动作命名,一般采用动词或者动词+名词的结构。

    建议3.10 函数指针除了前缀,其他按照函数的命名规则命名。

    4 变量

    原则4.1 一个变量只有一个功能,不能把一个变量用作多种用途。
    说明:一个变量只用来表示一个特定功能,不能把一个变量作多种用途,即同一变量取值不同时,其代表的意义也不同。

    原则4.2 结构功能单一;不要设计面面俱到的数据结构。
    说明:相关的一组信息才是构成一个结构体的基础,结构的定义应该可以明确的描述一个对象,而不是一组相关性不强的数据的集合。

    原则4.3 不用或者少用全局变量。
    说明:单个文件内部可以使用static的全局变量,可以将其理解为类的私有成员变量。

    规则4.1 防止局部变量与全局变量同名。
    说明:尽管局部变量和全局变量的作用域不同而不会发生语法错误,但容易使人误解。

    规则4.2 通讯过程中使用的结构,必须注意字节序。
    说明:通讯报文中,字节序是一个重要的问题,我司设备使用的cpu类型复杂多样,大小端、32位/64位的处理器也都有,如果结构会在报文交互过程中使用,必须考虑字节序问题。

    规则4.3 严禁使用未经初始化的变量作为右值。
    说明:坚持建议4.3(在首次使用前初始化变量,初始化的地方离使用的地方越近越好。)可以有效避免未初始化错误。

    建议4.1 构造仅有一个模块或函数可以修改、创建,而其余有关模块或函数只访问的全局变量,防止多个不同模块或函数都可以修改、创建同一全局变量的现象。
    说明:降低全局变量耦合度。

    建议4.2 使用面向接口编程思想,通过API访问数据:如果本模块的数据需要对外部模块开放,应提供接口函数来设置、获取,同时注意全局数据的访问互斥。
    说明:避免直接暴露内部数据给外部模型使用,是防止模块间耦合最简单有效的方法。

    建议4.3 在首次使用前初始化变量,初始化的地方离使用的地方越近越好。
    说明:未初始化变量是C和C++程序中错误的常见来源。在变量首次使用前确保正确初始化。
    在较好的方案中,变量的定义和初始化要做到亲密无间。

    建议4.4 明确全局变量的初始化顺序,避免跨模块的初始化依赖。
    说明:系统启动阶段,使用全局变量前,要考虑到该全局变量在什么时候初始化,使用全局变量和初始化全局变量,两者之间的时序关系,谁先谁后,一定要分析清楚,不然后果往往是低级而又灾难性的。

    建议4.5 尽量减少没有必要的数据类型默认转换与强制转换。
    说明:当进行数据类型强制转换时,其数据的意义、转换后的取值等都有可能发生变化,而这些细节若考虑不周,就很有可能留下隐患。

    5 宏、常量##

    规则5.1 用宏定义表达式时,要使用完备的括号。
    说明:因为宏只是简单的代码替换,不会像函数一样先将参数计算后,再传递。

    规则5.2 将宏所定义的多条表达式放在大括号中。
    说明:更好的方法是多条语句写成do while(0)的方式。

    规则5.3 使用宏时,不允许参数发生变化。

    规则5.4 不允许直接使用魔鬼数字。
    说明:使用魔鬼数字的弊端:代码难以理解;如果一个有含义的数字多处使用,一旦需要修改这个数值,代价惨重。

    建议5.1 除非必要,应尽可能使用函数代替宏。
    说明:宏对比函数,有一些明显的缺点:1.宏缺乏类型检查,不如函数调用检查严格。2.宏展开可能会产生意想不到的副作用,如#define SQUARE(a) (a) * (a)这样的定义,如果是SQUARE(i++),就会导致i被加两次;如果是函数调用double square(double a) {return a * a;}则不会有此副作用。3.以宏形式写的代码难以调试难以打断点,不利于定位问题。4.宏如果调用的很多,会造成代码空间的浪费,不如函数空间效率高。

    建议5.2 常量建议使用const定义代替宏。
    说明:尽量用编译器而不用预处理,因为#define经常被认为好象不是语言本身的一部分。

    建议5.3 宏定义中尽量不使用return、goto、continue、break等改变程序流程的语句。
    说明:如果在宏定义中使用这些改变流程的语句,很容易引起资源泄漏问题,使用者很难自己察觉。

    6 质量保证##

    原则6.1 代码质量保证优先原则
    (1)正确性,指程序要实现设计要求的功能。
    (2)简洁性,指程序易于理解并且易于实现。
    (3)可维护性,指程序被修改的能力,包括纠错、改进、新需求或功能规格变化的适应能力。
    (4)可靠性,指程序在给定时间间隔和环境条件下,按设计要求成功运行程序的概率。
    (5)代码可测试性,指软件发现故障并隔离、定位故障的能力,以及在一定的时间和成本前提下,进行测试设计、测试执行的能力。
    (6)代码性能高效,指是尽可能少地占用系统资源,包括内存和执行时间。
    (7)可移植性,指为了在原来设计的特定环境之外运行,对系统进行修改的能力。
    (8)个人表达方式/个人方便性,指个人编程习惯。

    原则6.2 要时刻注意易混淆的操作符。
    说明:包括易混淆和的易用错操作符

    原则6.3 必须了解编译系统的内存分配方式,特别是编译系统对不同类型的变量的内存分配规则,如局部变量在何处分配、静态变量在何处分配等。

    原则6.4 不仅关注接口,同样要关注实现。
    说明:这个原则看似和“面向接口”编程思想相悖,但是实现往往会影响接口,函数所能实现的功能,除了和调用者传递的参数相关,往往还受制于其他隐含约束,如:物理内存的限制,网络状况,具体看“抽象漏洞原则”。

    规则6.1 禁止内存操作越界。
    说明:内存操作主要是指对数组、指针、内存地址等的操作。内存操作越界是软件系统主要错误之一,后果往往非常严重,所以当我们进行这些操作时一定要仔细小心。
    坚持下列措施可以避免内存越界:
     数组的大小要考虑最大情况,避免数组分配空间不够。
     避免使用危险函数sprintf /vsprintf/strcpy/strcat/gets操作字符串,使用相对安全的函数snprintf/strncpy/strncat/fgets代替。
     使用memcpy/memset时一定要确保长度不要越界
     字符串考虑最后的’\0’, 确保所有字符串是以’\0’结束
     指针加减操作时,考虑指针类型长度
     数组下标进行检查
     使用时sizeof或者strlen计算结构/字符串长度,避免手工计算

    规则6.2 禁止内存泄漏。
    说明:内存和资源(包括定时器/文件句柄/Socket/队列/信号量/GUI等各种资源)泄漏是常见的错误。
    坚持下列措施可以避免内存泄漏:
     异常出口处检查内存、定时器/文件句柄/Socket/队列/信号量/GUI等资源是否全部释放
     删除结构指针时,必须从底层向上层顺序删除
     使用指针数组时,确保在释放数组时,数组中的每个元素指针是否已经提前被释放了
     避免重复分配内存
     小心使用有return、break语句的宏,确保前面资源已经释放
     检查队列中每个成员是否释放

    规则6.3 禁止引用已经释放的内存空间。
    说明:在实际编程过程中,稍不留心就会出现在一个模块中释放了某个内存块,而另一模块在随后的某个时刻又使用了它。要防止这种情况发生。
    坚持下列措施可以避免引用已经释放的内存空间:
     内存释放后,把指针置为NULL;使用内存指针前进行非空判断。
     耦合度较强的模块互相调用时,一定要仔细考虑其调用关系,防止已经删除的对象被再次使用。
     避免操作已发送消息的内存。
     自动存储对象的地址不应赋值给其他的在第一个对象已经停止存在后仍然保持的对象(具有更大作用域的对象或者静态对象或者从一个函数返回的对象)

    规则6.4 编程时,要防止差1错误。
    说明:此类错误一般是由于把“<=”误写成“<”或“>=”误写成“>”等造成的,由此引起的后果,很多情况下是很严重的,所以编程时,一定要在这些地方小心。当编完程序后,应对这些操作符进行彻底检查。使用变量时要注意其边界值的情况。

    规则6.5 所有的if … else if结构应该由else子句结束 ;switch语句必须有default分支。

    建议6.1 函数中分配的内存,在函数退出之前要释放。
    说明:有很多函数申请内存,保存在数据结构中,要在申请处加上注释,说明在何处释放。

    建议6.2 if语句尽量加上else分支,对没有else分支的语句要小心对待。

    建议6.3 不要滥用goto语句。
    说明:goto语句会破坏程序的结构性,所以除非确实需要,最好不使用goto语句。

    建议6.4 时刻注意表达式是否会上溢、下溢。

    7 程序效率

    原则7.1 在保证软件系统的正确性、简洁、可维护性、可靠性及可测性的前提下,提高代码效率。
    说明:不能一味地追求代码效率,而对软件的正确、简洁、可维护性、可靠性及可测性造成影响。

    原则7.2 通过对数据结构、程序算法的优化来提高效率。

    建议7.1 将不变条件的计算移到循环体外。
    说明:将循环中与循环无关,不是每次循环都要做的操作,移到循环外部执行。

    建议7.2 对于多维大数组,避免来回跳跃式访问数组成员。

    建议7.3 创建资源库,以减少分配对象的开销。
    说明:例如,使用线程池机制,避免线程频繁创建、销毁的系统调用;使用内存池,对于频繁申请、释放的小块内存,一次性申请一个大块的内存,当系统申请内存时,从内存池获取小块内存,使用完毕再释放到内存池中,避免内存申请释放的频繁系统调用.

    建议7.4 将多次被调用的 “小函数”改为inline函数或者宏实现。
    说明: 如果编译器支持inline,可以采用inline函数。否则可以采用宏。

    8 注释

    原则8.1 优秀的代码可以自我解释,不通过注释即可轻易读懂。
    说明:优秀的代码不写注释也可轻易读懂,注释无法把糟糕的代码变好,需要很多注释来解释的代码往往存在坏味道,需要重构。

    原则8.2 注释的内容要清楚、明了,含义准确,防止注释二义性。
    说明:有歧义的注释反而会导致维护者更难看懂代码,正如带两块表反而不知道准确时间。

    原则8.3 在代码的功能、意图层次上进行注释,即注释解释代码难以直接表达的意图,而不是重复描述代码。
    说明:注释的目的是解释代码的目的、功能和采用的方法,提供代码以外的信息,帮助读者理解代码,防止没必要的重复注释信息。

    规则8.1 修改代码时,维护代码周边的所有注释,以保证注释与代码的一致性。不再有用的注释要删除。
    说明:不要将无用的代码留在注释中,随时可以从源代码配置库中找回代码;即使只是想暂时排除代码,也要留个标注,不然可能会忘记处理它。

    规则8.2 文件头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者姓名、工号、内容、功能说明、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。
    说明:通常头文件要对功能和用法作简单说明,源文件包含了更多的实现细节或算法讨论。

    规则8.3 函数声明处注释描述函数功能、性能及用法,包括输入和输出参数、函数返回值、可重入的要求等;定义处详细描述函数功能和实现要点,如实现的简要步骤、实现的理由、设计约束等。
    说明:重要的、复杂的函数,提供外部使用的接口函数应编写详细的注释。

    规则8.4 全局变量要有较详细的注释,包括对其功能、取值范围以及存取时注意事项等的说明。

    规则8.5 注释应放在其代码上方相邻位置或右方,不可放在下面。如放于上方则需与其上面的代码用空行隔开,且与下方代码缩进相同。

    规则8.6 对于switch语句下的case语句,如果因为特殊情况需要处理完一个case后进入下一个case处理,必须在该case语句处理完、下一个case语句前加上明确的注释。
    说明:这样比较清楚程序编写者的意图,有效防止无故遗漏break语句。

    规则8.7 避免在注释中使用缩写,除非是业界通用或子系统内标准化的缩写。

    规则8.8 同一产品或项目组统一注释风格。

    建议8.1 避免在一行代码或表达式的中间插入注释。
    说明:除非必要,不应在代码或表达中间插入注释,否则容易使代码可理解性变差。

    建议8.2 注释应考虑程序易读及外观排版的因素,使用的语言若是中、英兼有的,建议多使用中文,除非能用非常流利准确的英文表达。对于有外籍员工的,由产品确定注释语言。
    说明:注释语言不统一,影响程序易读性和外观排版,出于对维护人员的考虑,建议使用中文。

    建议8.3 文件头、函数头、全局常量变量、类型定义的注释格式采用工具可识别的格式。
    说明:采用工具可识别的注释格式,例如doxygen格式,方便工具导出注释形成帮助文档。

    9 排版与格式

    规则9.1 程序块采用缩进风格编写,每级缩进为4个空格。
    说明:当前各种编辑器/IDE都支持TAB键自动转空格输入,需要打开相关功能并设置相关功能。

    规则9.2 相对独立的程序块之间、变量说明之后必须加空行。

    规则9.3 一条语句不能过长,如不能拆分需要分行写。一行到底多少字符换行比较合适,产品可以自行确定。
    说明:对于目前大多数的PC来说,132比较合适(80/132是VTY常见的行宽值);对于新PC宽屏显示器较多的产品来说,可以设置更大的值。

    规则9.4 多个短语句(包括赋值语句)不允许写在同一行内,即一行只写一条语句。

    规则9.5 if、for、do、while、case、switch、default等语句独占一行。
    说明:执行语句必须用缩进风格写,属于if、for、do、while、case、switch、default等下一个缩进级别;

    规则9.6 在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如->),后不应加空格。
    说明:采用这种松散方式编写代码的目的是使代码更加清晰。

    建议9.1 注释符(包括„/‟„//‟„/‟)与注释内容之间要用一个空格进行分隔。
    说明:这样可以使注释的内容部分更清晰。

    建议9.2 源程序中关系较为紧密的代码应尽可能相邻。

    10 表达式

    规则10.1 表达式的值在标准所允许的任何运算次序下都应该是相同的。
    说明:除了少数操作符(函数调用操作符 ( )、&&、| |、? : 和 , (逗号)) 之外,子表达式所依据的运算次序是未指定的并会随时更改。注意,运算次序的问题不能使用括号来解决,因为这不是优先级的问题。

    建议10.1 函数调用不要作为另一个函数的参数使用,否则对于代码的调试、阅读都不利。
    说明:如下代码不合理,仅用于说明当函数作为参数时,由于参数压栈次数不是代码可以控制的,可能造成未知的输出。

    建议10.2 赋值语句不要写在if等语句中,或者作为函数的参数使用。
    说明:因为if语句中,会根据条件依次判断,如果前一个条件已经可以判定整个条件,则后续条件语句不会再运行,所以可能导致期望的部分赋值没有得到运行。

    建议10.3 用括号明确表达式的操作顺序,避免过分依赖默认优先级。
    说明:使用括号强调所使用的操作符,防止因默认的优先级与设计思想不符而导致程序出错;同时使得代码更为清晰可读,然而过多的括号会分散代码使其降低了可读性。下面是如何使用括号的建议。

    建议10.4 赋值操作符不能使用在产生布尔值的表达式上。
    说明:如果布尔值表达式需要赋值操作,那么赋值操作必须在操作数之外分别进行。这可以帮助避免=和= =的混淆,帮助我们静态地检查错误。

    11 代码编辑、编译

    规则11.1 使用编译器的最高告警级别,理解所有的告警,通过修改代码而不是降低告警级别来消除所有告警。
    说明:编译器是你的朋友,如果它发出某个告警,这经常说明你的代码中存在潜在的问题。

    规则11.2 在产品软件(项目组)中,要统一编译开关、静态检查选项以及相应告警清除策略。
    说明:如果必须禁用某个告警,应尽可能单独局部禁用,并且编写一个清晰的注释,说明为什么屏蔽。

    规则11.3 本地构建工具(如PC-Lint)的配置应该和持续集成的一致。
    说明:两者一致,避免经过本地构建的代码在持续集成上构建失败。

    规则11.4 使用版本控制(配置管理)系统,及时签入通过本地构建的代码,确保签入的代码不会影响构建成功。
    说明:及时签入代码降低集成难度。

    建议11.1 要小心地使用编辑器提供的块拷贝功能编程。

    12 可测性

    原则12.1 模块划分清晰,接口明确,耦合性小,有明确输入和输出,否则单元测试实施困难。
    说明:单元测试实施依赖于:
     模块间的接口定义清楚、完整、稳定;
     模块功能的有明确的验收条件(包括:预置条件、输入和预期结果);
     模块内部的关键状态和关键数据可以查询,可以修改;
     模块原子功能的入口唯一;
     模块原子功能的出口唯一;
     依赖集中处理:和模块相关的全局变量尽量的少,或者采用某种封装形式。

    规则12.1 在同一项目组或产品组内,要有一套统一的为集成测试与系统联调准备的调测开关及相应打印函数,并且要有详细的说明。
    说明:本规则是针对项目组或产品组的。代码至始至终只有一份代码,不存在开发版本和测试版本的说法。测试与最终发行的版本是通过编译开关的不同来实现的。并且编译开关要规范统一。统一使用编译开关来实现测试版本与发行版本的区别,一般不允许再定义其它新的编译开关。

    规则12.2 在同一项目组或产品组内,调测打印的日志要有统一的规定。
    说明:统一的调测日志记录便于集成测试,具体包括:
     统一的日志分类以及日志级别;
     通过命令行、网管等方式可以配置和改变日志输出的内容和格式;
     在关键分支要记录日志,日志建议不要记录在原子函数中,否则难以定位;
     调试日志记录的内容需要包括文件名/模块名、代码行号、函数名、被调用函数名、错误码、错误发生的环境等。

    规则12.3 使用断言记录内部假设。
    说明:断言是对某种内部模块的假设条件进行检查,如果假设不成立,说明存在编程、设计错误。断言可以对在系统中隐藏很深,用其它手段极难发现的问题进行定位,从而缩短软件问题定位时间,提高系统的可测性。

    规则12.4 不能用断言来检查运行时错误。
    说明:断言是用来处理内部编程或设计是否符合假设;不能处理对于可能会发生的且必须处理的情况要写防错程序,而不是断言。如某模块收到其它模块或链路上的消息后,要对消息的合理性进行检查,此过程为正常的错误检查,不能用断言来实现。

    13 安全性

    原则13.1 对用户输入进行检查。
    说明:不能假定用户输入都是合法的,因为难以保证不存在恶意用户,即使是合法用户也可能由于误用误操作而产生非法输入。用户输入通常需要经过检验以保证安全。

    规则13.1 确保所有字符串是以NULL结束。
    说明:C语言中‟\0‟作为字符串的结束符,即NULL结束符。标准字符串处理函数(如strcpy()、strlen())依赖NULL结束符来确定字符串的长度。没有正确使用NULL结束字符串会导致缓冲区溢出和其它未定义的行为。

    规则13.2 不要将边界不明确的字符串写到固定长度的数组中。
    说明:边界不明确的字符串(如来自gets()、getenv()、scanf()的字符串),长度可能大于目标数组长度,直接拷贝到固定长度的数组中容易导致缓冲区溢出。

    规则13.3 避免整数溢出。
    说明:当一个整数被增加超过其最大值时会发生整数上溢,被减小小于其最小值时会发生整数下溢。带符号和无符号的数都有可能发生溢出。

    规则13.4 避免符号错误。
    说明:有时从带符号整型转换到无符号整型会发生符号错误,符号错误并不丢失数据,但数据失去了原来的含义

    规则13.5:避免截断错误。
    说明:将一个较大整型转换为较小整型,并且该数的原值超出较小类型的表示范围,就会发生截断错误,原值的低位被保留而高位被丢弃。截断错误会引起数据丢失。

    规则13.6:确保格式字符和参数匹配。
    说明:使用格式化字符串应该小心,确保格式字符和参数之间的匹配,保留数量和数据类型。格式字符和参数之间的不匹配会导致未定义的行为。大多数情况下,不正确的格式化字符串会导致程序异常终止。

    规则13.7 避免将用户输入作为格式化字符串的一部分或者全部。
    说明:调用格式化I/O函数时,不要直接或者间接将用户输入作为格式化字符串的一部分或者全部。攻击者对一个格式化字符串拥有部分或完全控制,存在以下风险:进程崩溃、查看栈的内容、改写内存、甚至执行任意代码。

    规则13.8 避免使用strlen()计算二进制数据的长度。
    说明:strlen()函数用于计算字符串的长度,它返回字符串中第一个NULL结束符之前的字符的数量。因此用strlen()处理文件I/O函数读取的内容时要小心,因为这些内容可能是二进制也可能是文本。

    规则13.9 使用int类型变量来接受字符I/O函数的返回值。
    说明:字符I/O函数fgetc()、getc()和getchar()都从一个流读取一个字符,并把它以int值的形式返回。如果这个流到达了文件尾或者发生读取错误,函数返回EOF。fputc()、putc()、putchar()和ungetc()也返回一个字符或EOF。如果这些I/O函数的返回值需要与EOF进行比较,不要将返回值转换为char类型。因为char是有符号8位的值,int是32位的值。如果getchar()返回的字符的ASCII值为0xFF,转换为char类型后将被解释为EOF。因为这个值被有符号扩展为0xFFFFFFFF(EOF的值)执行比较。

    规则13.10 防止命令注入。
    说明:C99函数system()通过调用一个系统定义的命令解析器(如UNIX的shell,Windows的CMD.exe)来执行一个指定的程序/命令。类似的还有POSIX的函数popen()。如果system()的参数由用户的输入组成,恶意用户可以通过构造恶意输入,改变system()调用的行为。

    14 单元测试

    规则14.1 在编写代码的同时,或者编写代码前,编写单元测试用例验证软件设计/编码的正确。

    建议14.1 单元测试关注单元的行为而不是实现,避免针对函数的测试。
    说明:应该将被测单元看做一个被测的整体,根据实际资源、进度和质量风险,权衡代码覆盖、打桩工作量、补充测试用例的难度、被测对象的稳定程度等,一般情况下建议关注模块/组件的测试,尽量避免针对函数的测试。尽管有时候单个用例只能专注于对某个具体函数的测试,但我们关注的应该是函数的行为而不是其具体实现细节。

    15 可移植性

    规则15.1 不能定义、重定义或取消定义标准库/平台中保留的标识符、宏和函数。

    建议15.1 不使用与硬件或操作系统关系很大的语句,而使用建议的标准语句,以提高软件的可移植性和可重用性。
    说明:使用标准的数据类型,有利于程序的移植。

    推荐阅读材料:
    C语言接口与实现
    敏捷软件开发
    函数式语言的优势
    抽象漏洞原则
    代码大全
    doxygen中文手册
    代码整洁之道
    google c++编程规范
    汽车业c语言使用规范(misra)

    2018.1.27

    展开全文
  • 华为技术有限公司c++编程规范,很有参考意义。高清pdf
  • 华为C语言编程规范总则pdf和word合集
  • 华为技术有限公司C语言编程规范,适合初学者以及求职者参考借鉴,提高自己的代码水平
  • 免积分下载 华为技术有限公司c语言编程规范PDF
  • 华为C语言编程规范

    2018-07-17 09:47:00
    示例:如下例子不符合规范。 例1: /* get replicate sub system index and net indicator */ repssn_ind = ssn_data[index].repssn_index; repssn_ni = ssn_data[index].ni; 例2: repssn_ind = ssn_data[index]....

    2-1:一般情况下,源程序有效注释量必须在20%以上。

    说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。

    2-2:文件头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、修改日志等。

    示例:下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。

    /*****************************************************************************
    Copyright: 1988-1999, Huawei Tech. Co., Ltd.
    File name: 文件名
    Description: 用于详细说明此程序文件完成的主要功能,与其他模块或函数的接口,输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系
    Author: 作者
    Version: 版本
    Date: 完成日期
    History: 修改历史记录列表, 每条修改记录应包括修改日期、修改者及修改内容简述。
    *****************************************************************************/
    2-3:函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。

    示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。
    /*************************************************
    Function: // 函数名称
    Description: // 函数功能、性能等的描述
    Calls: // 被本函数调用的函数清单
    Called By: // 调用本函数的函数清单
    Table Accessed: // 被访问的表(此项仅对于牵扯到数据库操作的程序)
    Table Updated: // 被修改的表(此项仅对于牵扯到数据库操作的程序)
    Input: // 输入参数说明,包括每个参数的作// 用、取值说明及参数间关系。
    Output: // 对输出参数的说明。
    Return: // 函数返回值的说明
    Others: // 其它说明
    *************************************************/
    2-4:边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。

    2-5:注释的内容要清楚、明了,含义准确,防止注释二义性。说明:错误的注释不但无益反而有害。

    2-6:注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。

    示例:如下例子不符合规范。
    例1:
    /* get replicate sub system index and net indicator */
    repssn_ind = ssn_data[index].repssn_index;
    repssn_ni = ssn_data[index].ni;
    例2:
    repssn_ind = ssn_data[index].repssn_index;
    repssn_ni = ssn_data[index].ni;
    /* get replicate sub system index and net indicator */

    应如下书写
    /* get replicate sub system index and net indicator */
    repssn_ind = ssn_data[index].repssn_index;
    repssn_ni = ssn_data[index].ni;

    2-7:对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注释,说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。

    示例:
    /* active statistic task number */
    #define MAX_ACT_TASK_NUMBER 1000
    #define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */

    2-8:数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须加以注释。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方。

    示例:可按如下形式说明枚举/数据/联合结构。
    /* sccp interface with sccp user primitive message name */
    enum SCCP_USER_PRIMITIVE
    {
    N_UNITDATA_IND, /* sccp notify sccp user unit data come */
    N_NOTICE_IND, /* sccp notify user the No.7 network can not */
    /* transmission this message */
    N_UNITDATA_REQ, /* sccp user's unit data transmission request*/
    };

    2-9:全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。

    示例:
    /* The ErrorCode when SCCP translate */
    /* Global Title failure, as follows */ // 变量作用、含义
    /* 0 - SUCCESS 1 - GT Table error */
    /* 2 - GT error Others - no use */ // 变量取值范围
    /* only function SCCPTranslate() in */
    /* this modual can modify it, and other */
    /* module can visit it through call */
    /* the function GetGTTransErrorCode() */ // 使用方法
    BYTE g_GTTranErrorCode;

    2-10:注释与所描述内容进行同样的缩排。

    说明:可使程序排版整齐,并方便注释的阅读与理解。示例:如下例子,排版不整齐,阅读稍感不方便。
    void example_fun( void )
    {
    /* code one comments */
    CodeBlock One
    /* code two comments */
    CodeBlock Two
    }

    应改为如下布局。
    void example_fun( void )
    {
    /* code one comments */
    CodeBlock One
    /* code two comments */
    CodeBlock Two
    }

    2-11:避免在一行代码或表达式的中间插入注释。

    说明:除非必要,不应在代码或表达中间插入注释,否则容易使代码可理解性变差。

    2-12:通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构,使代码成为自注释的。

    说明:清晰准确的函数、变量等的命名,可增加代码可读性,并减少不必要的注释。

    2-13:在代码的功能、意图层次上进行注释,提供有用、额外的信息。

    说明:注释的目的是解释代码的目的、功能和采用的方法,提供代码以外的信息,帮助读者理解代码,防止没必要的重复注释信息。

    示例:如下注释意义不大。
    /* if receive_flag is TRUE */
    if (receive_flag)

    而如下的注释则给出了额外有用的信息。
    /* if mtp receive a message from links */
    if (receive_flag)

    2-14:在程序块的结束行右方加注释标记,以表明某程序块的结束。

    说明:当代码段较长,特别是多重嵌套时,这样做可以使代码更清晰,更便于阅读。示例:参见如下例子。
    if (...)
    {
    // program code
    while (index < MAX_INDEX)
    {
    // program code
    } /* end of while (index < MAX_INDEX) */ // 指明该条while 语句结束
    } /* end of if (...)*/ // 指明是哪条if 语句结束

    2-15:注释格式尽量统一,建议使用“/* …… */”。

    2-16:注释应考虑程序易读及外观排版的因素,使用的语言若是中、英兼有的,建议多使用中文,除非能用非常流利准确的英文表达。

    说明:注释语言不统一,影响程序易读性和外观排版,出于对维护人员的考虑,建议使用中文。

    转载于:https://www.cnblogs.com/liangbo-1024/p/9321707.html

    展开全文
  • 华为技术有限公司c语言编程规范 PDF
  • 华为C&C 语言安全编程规范_V3.1,华为c语言通用编程规范v3.2,C,C++源码.rar,华为C&C 语言安全编程规范_V3.1.pdf
  • 华为技术有限公司c语言编程规范
  • 华为C语言试题及参考答案.pdf
  • 华为技术有限公司c语言编程规范.zip,华为技术有限公司c语言编程规范.pdf
  • 华为技术有限公司C++语言编程规范 高清PDF格式 文字版 含目录
  • 华为技术有限公司c语言编程规范,华为技术有限公司c语言编程规范.pdf,C,C++源码

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 414
精华内容 165
关键字:

华为c语言编程规范pdf