Visual C++代码标准文档.docVIP

Visual C++ 代码标准文档 1 前言 2 2 源程序书写规范 2 2.1 通用源代码书写规范 2 2.1.1 缩进 2 2.1.2 边距 2 2.1.3 复合语句标识“{”和“}” 2 2.1.4 注释 2 2.2 语句格式、语句书写规范与用法 3 2.2.1 括号 3 2.2.2 保留字和关键字 3 2.2.3 函数 4 2.2.4 变量 4 2.2.5 类型 4 2.2.6 语句 5 3 命名规范 6 3.1 函数 6 3.1.1 函数名 6 3.1.2 形参 6 3.2 变量 6 3.2.1 一般局部变量 7 3.2.2 全局变量 7 3.2.3 类内部成员变量 7 3.2.4 类实例变量 7 3.3 类与结构 7 3.3.1 类的定义 7 3.3.2 成员变量 8 3.4 文件 8 3.4.1 项目文件 8 3.4.2 类文件 8 3.4.3 其他文件 9 4 源程序文档注释规范 9 4.1 注释文档的一般规范 9 4.1.1 注释位置 9 4.1.2 注释块 9 4.2 文件注释文档格式 10 4.3 函数的注释文档格式 10 1 前言 本文档主要室为Visual C++开发人员提供一个源代码书写标准，以及程序和文件的命名标准，使他们在编程时有一致的格式可以遵循。这样，每个编程人员编写的代码能够被其他人理解。 本文档不包含用户界面标准。 2 源程序书写规范 2.1 通用源代码书写规范 2.1.1 缩进 缩进就是每级代码之间有一定空间。定义每级代码之间放置一个制表符，并且要将编程环境中的制表符设置为占用四个字符位置。 在 Visual C++ 环境中，通过选择菜单 Tools - Options，选择 Tabs 设置页，将 Tab Size 和 Indent Size 设置为4，并选择 Keep tabs 选项。 2.1.2 边距 边距设置可以灵活掌握，建议设置为120个字符。只要可能，超过边距长度的一行语句应用换行符换行。换行后，应缩进两个字符。 2.1.3 复合语句标识“{”和“}” 复合语句标识的括号应各占一行。例如，如下书写是正确的： if (i100) { nCount ++; } 而如下的写法是错误的： if (i100){ nCount ++;} 复合语句标识括号的两个部分缩进量要保持一致。 2.1.4 注释 通常使用双斜杠(//)进行注释。如果是大段代码的注释，使用注释符 /* 和 */。每个注释符需要自己占一行，例如，按如下书写： /* if (i100) { nCount ++; } */ 2.2 语句格式、语句书写规范与用法 2.2.1 括号 在左括号和下一字符之间没有空格。同样，右括号与前一字符之间页没有空格。例如，下面的书写是正确的： CallProc(nParam); 而如下的书写是错误的： CallProc( nParam ); 不要在语句中包含多余的括号嵌套，括号只在需要时使用。例如，如下书写是正确的： nCount = 4 * (nNum * 24); 而如下的书写是错误的： nCount = (4 * (nNum * 24)); 2.2.2 保留字和关键字 不要使用Visual C++中的保留字和关键字作为自定义标识符。Visual C++中的关键字和保留字如下（注意，全部为小写）： asm auto bad_cast bad_typeid bool break case catch char class const const_cast continue default delete do double dynamic_cast else enum except explicit extern false finally float for friend goto if inline int long mutable namespace new operator private protected public register reinterpret_cast return short signed sizeof static static_cast struct switch template this throw true try type_info typedef typeid typename union unsigned using virtual void volatile while 另外，还有如下保留字（双下划线开始的标识符）： allocate __inline property __asm1 __int8 selectany __based __int16 __single_inheritance