编码规范-东软-内部资料.docVIP

工程的目录结构 一个工程应该划分为若干个目录，目录应该是模块划分的体现。如： Project (ModuleName1 ModuleName2 …… ModuleNamen Include Bin Lib 其中include目录下应该放置公共的头文件。 Bin 目录下放执行文件 Lib目录下*.lib文件 目录名称要有意义 文件 文件的结构 文件的种类有两种：源文件（*.c）和头文件（*.h）。 源文件中一般应该包括的内容： 本文件需要包含的头文件； 只在本文件内部使用的（对外部隐藏的）类型； 只在本文件内部使用的（对外部隐藏的）常量； 只在本文件内部使用的（对外部隐藏的）宏定义； 只在本文件内部使用的函数原型说明； 只在本文件内部使用的（对外部隐藏的）变量的声明； 函数的代码实现。 头文件中应该包含的内容 提供给外部参照的类型； 提供给外部参照宏定义； 提供给外部参照（全局）函数原型说明； 文件划分的准则 高内聚； 低耦合； 文件的命名及文件的长度 文件名只能由小写字母、数字和’_’组合而成。 使用英语命名，尽量选用可以发音和有意义的名字。 一个文件的长度不要超过1000行代码。 源文件 一般说来，源文件的整体构成包括以下内容（有时可能不存在某些部分）。具体情况请参见源文件模板。 源文件的注释框 包含文件部分 宏定义部分 类型定义部分 结构体定义部分 全局变量定义部分 文件static变量定义部分 函数原型声明 调试开关定义部分 函数定义部分 头文件 一般说来，头文件的整体构成包括以下内容（有时可能不存在某些部分）。具体情况请参见头文件模板。 头文件的注释框 包含文件部分 宏定义部分 类型定义部分 结构体/类定义部分 函数原型声明 头文件应采用#ifndef/#define/#endif的方式来防止多次被包含，其中使用的宏名为：“__”+“文件名”+“_”+“扩展名”，文件名与扩展名均为大写。对 头文件的包含应该采用相对路径，而不采用绝对路径。 #include包含的文件名称应由小写字母、数字和’_’组合而成。 为了减少执行程序的大小，不应包含不需要的头文件。 头文件中不要定义变量。 程序格式―排版、注释 排版 分行 较长的语句、表达式等要分成多行书写，一行程序不要超过81列； 不允许把多个短语句写在一行中，即一行只写一条语句。 循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分；划分的原则：整齐、美观、符合其他编码规范。 若函数的参数较长，则要进行适当的划分。划分的原则：整齐、美观、符合其他编码规范。 在两个函数定义之间必须使用空行分开。 在函数定义中，用空行将代码按逻辑片断划分。 例如两个并列的判断语句之间就可以用空行来区分；变量的定义、变量的初始化以及真正的处理语句之间就可以用空行来区分。 意义不一致的宏定义之间、全局变量之间、函数声明之间需要添加空行。 如果函数参数不只有一个，则每个参数的定义各占一行，每行前有一个制表符的缩进。 最后一个参数的定义后要紧跟右括号。 定义函数体的左右大括号要各自独占一行。【可检查： 04-04-01】 空格 单目操作符后不要加空格。 单目操作符前不要加空格。 赋值符号前后要有一个空格。 位逻辑运算符号后的ASCII码应该有一个空格。 在条件表达式与括号间应该有一个空格。 在问号表达式（?）前后应该有一个空格。 在二元逻辑操作符前后应该有一个空格。 在比较操作符号前后应该有一个空格。 在“.”、“-”前后不应该有空格。 在数组名与“[”之间不应该有空格。 “,”之后应该有空格。 “；”之后应该有空格。 “sizeof”与“（”之间不应该有空格；“（”与类型之间不应该有空格。 缩进 代码缩进要使用制表符，而不是直接使用空格。 对嵌套语句使用一个制表符----Tab（4个字符）的缩进。 尽可能保证缩进嵌套的层数不超过四层。 注释 边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。 注释写在说明代码的上面。 注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。 注释与前面的执行语句之间空一行。 源文件的开头要有注释，但每个业务/项目由于客户的要求不同而有不同的注释格式，这里对注释格式不作统一要求。 注释不要有嵌套。 应对不易理解的分枝条件表达式加注释。 不易理解的循环, 应说明出口条件。 函数 函数命名 函数名只能由大小写字母与数字构成。 函数名中除前缀外的各个单词首字母要大写。 函数说明 函数必须都有函数说明。 说明中必须包含如下内容： 名称(Function Name)：函数的名称。 描述(Description)：函数功能的简单描述。 作成日期(Creat