C语言编程规范的.pdf

1 命名规则 如果想要有效的管理一个稍微复杂一点的体系，针对其中事物的一套统一、带层次结构、 清晰明了的命名准则就是必不可少而且非常好用的工具。 在软件开发这一高度抽象而且十分复杂的活动中，命名规则的重要性更显得 尤为突出。一套定义良好并且完整的、在整个项目中统一使用的命名规范将 大大提升源代码的可读性和软件的可维护性。 在引入细节之前，先说明一下命名规范的整体原则： 同一性 在编写一个子模块或派生类的时候，要遵循其基类 或整体模块的命名风格，保持命名风格在整个模块 中的同一性。 标识符组成 标识符采用英文单词或其组合，应当直观且可以拼 读，可望文知意，用词应当准确。 最小化长度 最大化信 在保持一个标识符意思明确的同时，应当尽量缩短 息量原则 其长度。 避免过于相似 不要出现仅靠大小写区分的相似的标识符，例如“i” 与“I”，“function”与“Function”等等。 避免在不同级别的作用域中 程序中不要出现名字完全相同的局部变量和全局变 重名 量，尽管两者的作用域不同而不会发生语法错误， 但容易使人误解。 正确命名具有互斥意义的标 用正确的反义词组命名具有互斥意义的标识符，如： 识符 nMinValue 和 nMaxValue ，GetName() 和 SetName() 避免名字中出现数字编号 尽量避免名字中出现数字编号，如 Value1,Value2 等，除非逻辑上的确需要编号。这是为了防止程序 员偷懒，不肯为命名动脑筋而导致产生无意义的名 字（因为用数字编号最省事）。 1.1 类/结构 除了异常类等个别情况（不希望用户把该类看作一个普通的、正常的类之情 况）外，C++类/结构的命名应该遵循以下准则： C++类/结构的命名 类的名称都要以大写字母 “C”开头，后跟一 个或多个单词。为便于界定，每个单词的首 字母要大写。 推荐的组成形式 类的命名推荐用名词或形容词＋名词的 形式，例如：CAnalyzer, CFastVector 不同于C++类的概念，传统的C 结构体只是一种将一组数据捆绑在一起的方 式。传统C 结构体的命名规则为： 传统C 结构体的命名 传统C 结构体的名称全部由大写字母组成， 单词间使用下划线界定，例如： SERVICE_STATUS, DRIVER_INFO 1.2 函数 函数的命名 函数的名称由一个或多个单词组成。为便于 界定，每个单词的首字母要大写。 推荐的组成形式 函数名应当使用动词或者动词＋名词 （动宾词组）的形式。例如：GetName(), SetValue()