C与C程序表示规范.docVIP

C/C++程序表示规范  目录 目录 1 C/C++程序表示规范 2 §1 引言 2 §1.1 目的 2 §1.2 背景 2 §1.3 定义 2 §1.4 参考资料 2 §2 程序文件名命名规则 3 §3 C/C++标识命名及书写规则 3 §3.1 基本规则 3 §3.2 含义标识命名及书写规则 4 §3.3 规范标识前缀 4 §3.3.1 变量前缀 4 §3.3.2 类型和类前缀 5 §3.3.3 宏和枚举的前缀 6 §3.3.4 函数的前缀 7 §3.3.5 局部对象的简化命名 9 §4 程序注释 9 §4.1 注释原则 9 §4.2 常量和变量的注释 10 §4.3 类型的注释 10 §4.4 函数的注释 10 §4.5 类的注释 11 §4.5 语句的注释: 11 §5 模块编写规范: 11 §5.1 模块划分的准则: 11 §5.2 模块的文件构成: 11 §5.3 模块的开发步骤建议 12 §5.4 模块设计编写注意事项: 12 §6 函数编写规范 12 §6.1 函数划分的准则: 12 §6.2 函数设计编写注意事项: 12 §7 缩进规范 12 §7.2 缩进的限制 14 §8 可移植性注意事项 16 §8.1 预编译头 16 §8.2 多平台编程注记 18 §1 引言 §1.1 目的 良好的编程风格是提高程序可靠性非常重要的手段, 也是大型项目多人合作开发的技术基础。本规范的目的在于通过规范定义来避免不好的编程风格, 增强程序的易读性, 便于自己和其它程序员理解。 §1.2 背景 作为一个软件企业, 程序表示规范是建立企业内部编程的共同语言, 随着人们对编程风格认识的逐渐统一, 程序表示规范已越来越必要和切实可行。 §1.3 定义 暂缺 §1.4 参考资料 §2 程序文件名命名规则 考虑UNIX和DOS的兼容性, 文件名限制为DOS文件名规则, 文件标识分为两部分，格式如下: 前缀 . 后缀 ××××××××. ××× １２３ 规则: (1) 前缀部分最好不超过8个,后缀部分由本规范定义, 一般为3个符, 通常表示该文件的类型(如是C程序,ASCII文本文件等). (2) 前缀和后缀这两部分字符应仅使用字母、数字和下划线(在DOS中: 前缀部分前8个字符是有效识别符, 后缀部分前3个字符是有效识别符). (3) 当文件是目录时, 仅可使用前缀格式作为目录名, 无后缀. (4) 在Windows 系统中,文件名的前缀命名与模块(类)名规范一致, 虽然这时所有的操作系统文件名支持空格等除0以外的所有字符, 但本规范还是建议使用高级语言中标识符的语法。UNIX和Win32位操作系统(Window95,WindowNT)都保留大小写区分的特征, 原DOS文件名在Win32位操作系统中均被转为大写, 从我国的语言特征来讲(小写通常是汉字录入), 使用全大写的文件名最为恰当, 但很多老的UNIX程序员习惯使用小写来命名(大多数编译程序也只支持小写后缀), 所以本规范只是建议文件名全部使用大写。 举例: (1) 8.3命名: obtbl.cxx, obtable.cxx (2) 长文件命名: OBJECTBASETable.cxx,OBTableClass.cxx, TABLE_CLASS.CXX §3 C/C++标识命名及书写规则 §3.1 基本规则 标识名分为两部分: 规范标识前缀+含义标识 标识的总长度不要超过32个字符。 这里的标识是指语言中语法对象的名字, 它们有常量名、变量名、函数名、类和类型名及预处理名, 标识名的基本语法是以字母开始,由字母数字及下划线组成的单词,我们将标识划分成这两个部分是基于如下原因: (1)用规范标识前缀来标名该标识所属的应用系统, 以便在应用系统间互相区别 (2)用规范标识前缀来标名该标识的归类特征,以便与其它类型的标识互相区别 (3)用含义标识来标名该标识所对应的被抽象的实体,以便记忆 (4)用这种命名法来区分本公司标识与外公司标识 §3.2 含义标识命名及书写规则 (1) 命名: 按其应用的含义由一个或多个词组成. 词可以是中文词或英文词. (2) 书写: 每个词的第一个字母大写, 其余全部小写, 词与词紧连(宏和枚举除外), 宏和枚举值标识全部大写, 词与词可用下划线分开. 中文词由中文描述含义的每个汉字的头一个拼音字母组成. 英文词尽量不缩写, 除非这种缩写比较通用, 不要在同一系统中对同一单词使用不同的表示法(如全写和缩写均使用). 全由大