Microsoft Word - C++CodeRule94.doc

Size: px

Start display at page:

Download "Microsoft Word - C++CodeRule94.doc"

庶臧
4 years ago
Views:

1 C++ 程序编制标准标准如下 : 一概述制定本编程格式的目的是为了使软件可读性好兼容性好易维护等等二程序的构成 C++ 程序的主要特点即为对象 (object) 的概念和数据封装性 (encaptulation) 所以, C++ 程序的主要内容包括 : 1 类 ( 包括基类子类等, 结构看作特殊的类 ) 的定义, 也就是类的描述说明 2 对象类的成员函数的定义, 即类的实现所有的类都既有属性定义, 又有成员函数的定义, 实现了数据的高度抽象及数据的封装, 这样就使软件更容易维护, 更易进行代码的重用另外, C++ 语言程序还包括如下几点要素 : 1 包含文件说明格式为 : #include <...> // 系统文件 #include "..." // 自定义的头文件一般应将包含文件的说明放在文件的开头 2 常数定义格式为 : #define MESSAGE 0 // C 语言格式 const MESSAGE = 0; // C++ 语言格式通常全局的常数定义, 使用 #define... 的格式, 而类定义内部的常数定义或成员函数内部的常数定义, 则使用 const... 的格式 3 宏定义格式为 : #define... 建议 C++ 程序中不使用宏定义, 而一律采用内联 ( inline ) 函数这样做的好处是 : 在跟踪程序运行时, 可以跟踪进入内联函数, 而不能进入宏定义中值得指出的是, 内联函数应尽可能的小 4 全局变量定义及全局函数的声明为使软件易于维护, 易于代码重用, 建议不用或者尽量减少使用全局变量和全局函数 5 外部变量说明 extern... 下面举例说明各种成分的结构和形式 * INCLUDE FILES * #include <stdio.h> #include "myclass.h" * 常数定义 *

2 // Error Code 定义 #define ERR_FILEIO (-1) // file I/O error #define ERR_SYS (-2) // system service error #define ERR_MALLOC (-3) // memory allocation error #define ERR_PARAMETER (-4) // parameter error * 外部变量说明 * extern CDrawClass ocdmydraw; // my object define * 全局变量定义 * CDrawClass ocdmydraw; // my object define. * 全局函数声明 * void GetObjLen( CDraw *pocddraw ); // 注释三源文件的命名规则及构成 1 文件命名: 1 文件扩展名 xxxxxxxx.h 用于记载类 ( 基子类 ) 的定义描述全局变量的描述的文件 xxxxxxxx.cpp 用于记载类成员函数描述的文件 2 文件名文件应当按照它所记载的内容来命名类的定义文件 ( xxxxxxxx.h ) 及其实现文件 ( xxxxxxxx.cpp ) 的名字应尽量一致例如 : CDraw.h : 描述了 CDraw 类的定义 CDraw.cpp : 描述了 CDraw 类的成员函数的实现定义从可移植性的角度考虑, 文件名的长度一般应在 8 个字符以内同时, 字母的大小写应该是有区别的另外, 文件名应按照事物在客观世界中所存在的性质来描述, 尽量做到让人一目了然这正体现了面向对象方法本身是按照人类的客观思维来构造的 3 主函数所在文件的命名 : 主函数所在文件名应定义为 xxxxmain.cpp, 以示标明 2 文件的构成: 1 最好同一个类中的成员函数的实现集中在同一个文件 ( *.cpp ) 中描述 2 当程序的规模不大时, 同一个基类所导出的子类定义最好能与基类定义在一起 ( *.h 文件中 ) 同理, 子类成员函数的实现则与基类成员函数的实现在同一个 (*.cpp) 文件中 3 当程序的规模较大时, 子类成员函数的实现则与基类成员函数的实现分开存放在不同的文件一个源文件的大小一般应控制在 1000 行以内

3 四各种语句的书写格式及留空规定为了使程序具有良好的可读性, 我们对语句的书写格式及语句前的留空进行了明确的规定程序的相邻层次的语句之前的留空个数一般为 4 个空格, 但 SWITCH/CASE 语句和函数形参定义语句前只留 2 个空格 1 一行的文字数程序的一行的字符个数应在 72 之内, 以便于程序的阅读和输出 2SWITCH 语句的书写格式 switch(ch) { case TAB: // 注释 break; default: // 注释 break; 3IF 语句的书写格式 if( 条件 ) { // 注释 else if( 条件 ) { // 注释 else { 4DO WHILE 语句的书写格式 while( 条件 ) { // 注释 do { // 注释 while( 条件 ); 5FOR 语句的书写格式 for(..;..;..) { // 注释 6 类定义的标准格式为了书写格式的美观, 在访问权限后的 "// 属性 " 注释缩进去两个空格, 在其后的属性声明则再缩进去两个空格 /********************************************************** * NAME : 类名 * * BASE CLASS NAME : 基类名 * * FUNCTION : 类的主要功能 * *********************************************************/ class 类名 : 访问权限基类名

4 { public: protected: private: ; 例如 : class CAppWindow : public CFrameWnd { public: int nxword; // 注释 int nyword; // 注释 // 构造器 CAppWindow(); // 析构器 ~CAppWindow(); // 设置行尺寸大小 void SetLineSize( int nxlineval, int nylineval );... protected: int nxline; // 注释 int nyline; // 注释 // 设置关闭文件 void OnClose();... private:

5 int nxpage; // 注释 int nypage; // 注释 // 设置画文件 void OnPaint();... ; 7 成员函数的书写格式 /************************************************************** * NAME : 成员函数名 * * CLASS NAME : 所属的类名 * * FUNCTION : 函数功能 * * PROCESS : 处理大致过程 * * INPUT : 输入参数及含义 * * RETURN : 返回值及类型 * *************************************************************/ void CAppWindow::OnPaint() { char sstr[80]; // this is... char *pstr; // the pointer is... for( int i = 0; i < nypage; i++ ) {. 当 if for while 等语句嵌套较多且内部嵌套的语句较长时, 建议可在结束的 "" 后注上 " end if " "end for" 之类的信息, 以利于程序的阅读例如 : if(... ) { while(... ) { // end while // end if 五类对象函数和变量的命名规则 1. 类名一律以大写字母 "C" 开头, 其后接能够描述该类的最精确的最概括的单词 ( 一般为名词或动宾词组 ), 每个单词的头一个字母必须大写例如 : class CExample 或 class CInterClass {... {... ; ; 2. 成员函数名应当以大写字母开头, 成员函数名应当与系统函数标准函数名区分开来, 除专用目的的函数外 ( 例如函数的重载, 或运算符的重载等 ) 例如 : void CExample::GetName( char *pname )

6 { 对象的声明与变量名有一致的标准 : 前缀类型含义举例 i short 类型 short icount; n int 类型 int ncount; l long 类型 long ldatacount; c char 类型 char cinkey; b BOOL 类型 BOOL bflag; s 字符串类型 char sname[20]; p 指针类型 char *pmemaddr; o 对象的声明 CTreeClass otreetree1; h 句柄类型 HGLOBAL hglobalblock; st 结构类型 ParamStruct stmystruct; a 数组类型 int anmyarray; g 全局变量 char gcsyscomm;

7 其中, 对象的声明中, 例子 : CTreeClass o Tree Tree1; ( 前缀 ) ( 表明所属类 ) ( 有含义的对象名 ) 4. 所有的变量名应一律以小写字母开头 ( 切忌使用 ppp aaa ii 之类的不明意义的单词 ) 5. 全局变量应尽量按它所表示的内容来命名常数名 ( 用 #define 定义 ) 必须大写六条件编译语句的使用 1DEBUG 语句的使用使用 printf 语句进行调试时, 调试语句应写在 #ifdef DEBUG 和 #endif 之间, 这样, 只需简单地改变编译命令行参数就可以删除或使用调试语句 2 与环境有关的部分与操作系统或开发环境有关的部分应当写在条件编译语句之中, 这样便于系统的移植例如在制作可用 UNIX 和 DOS 下软件时, 依赖于 UNIX 的部分应写在 #ifdef UNIX 和 #endif 之间, 而依赖于 DOS 的部分应写在 #ifdef MSDOS 和 #endif 之间七注释的书写格式及内容 C++ 程序中有两种注释 : /*... */ 和 //... 现规定: 1 在文件头中及成员函数实现之前或类定义之前, 均使用 /*... */ 进行注释 2 在类定义的内部, 函数实现的内部, 均使用 //... 进行注释 1 文件头的注释 /************************************************************** * NAME : 文件名 * FUNCTION : 文件功能 * PROGRAMMED : SU/ 程序员名 * DATE(ORG) : * PROJECT : 项目名称 * OS : 所使用的操作系统 * HISTORY : * ID --- DATE NOTE * 初期作成 * 第二版 XX 机能修改 ( 追加 ) *************************************************************/ 2 函数头的注释 /*********************************************************** * NAME : 函数名 * FUNCTION : 函数功能 * PROCESS : 处理大致过程 * INPUT : 输入参数及含义 * OUTPUT : 输出参数及含义 * UPDATE : 输入输出参数及含义 * RETURN : 返回值及含义 * PROGRAMMED : SU/ 程序员名

8 * DATE(ORG) : * CALL : 调用的自定义函数列表 * SYSTEM : 调用的系统函数列表 *************************************************************/ 3 函数体内及类的定义内的注释 CExample::test(int argc, char *argv[] ) { int i; //... //... for( i=0;i<argc;i++) { //... if(!strcmp(argv[i],"display")) { //... statemeents;... //... Initial_something(); //... 八文件的变更格式文件提交以后, 文件的内容的变动须按以下格式进行 1 在文件头的注释中进行登记 *... * HISTORY : * ID --- DATE NOTE * 初期作成 * 修改内容 1 * 修改内容 2 * 2 段落删除 // deleted by XY #if 0 所需删除的段落 #endif 3 段落增加 // add by XY #if 1 所需增加的段落 #endif 4 段落修改 // modified by XY #if 0

9 修改前的段落 #else 修改后的段落 #endif 九为文档准备注释为了便于从程序中抽取注释, 现如下规定函数内部的注释 : //// 注释

FY.DOC

FY.DOC 高职高专 21 世纪规划教材 C++ 程序设计邓振杰主编贾振华孟庆敏副主编人民邮电出版社内容提要本书系统地介绍 C++ 语言的基本概念基本语法和编程方法, 深入浅出地讲述 C++ 语言面向对象的重要特征 : 类和对象抽象封装继承等主