文件头的注释在新建立一个文件时请在文件头加入如下注释.docVIP

编码规范 类成员函数 成员函数应该以完整的英文描述命名，函数名的第一个单词通常是一个动词。如openAccount、save等 对于存取类属性的成员函数有以下的命名规则： Getter：访问类的属性并返回。命名以get开头，如果返回值是boolean，以is开头；如getFirstName、isAtEnd等。boolean返回值的另一种命名方法是使用has、can，如hasDependents、canPrint等 Setter：设置类属性。命名以set开头，如setFirstName 成员函数的可见性，一个成员函数有三种可能的可见性：public、protected、private。如果一个成员函数不必是public的，那么设置成protected；如果它不必是protected，那么设置成private。 public：可以被类以外的其他函数访问 protected：可以被该类及其继承类的成员函数访问 private：只可以被该类的其他成员函数访问，不包括继承类 成员函数的注释 在C++中，类成员函数的定义和声明是分开的。那么有三个要注释的地方。 一个是成员函数的声明（在.h文件夹中），该处注释给出该函数简短的功能描述，使用的上下文关系（前条件、后条件等）以及可能抛出的异常。 成员函数定义处的注释给出函数详细的功能描述、输入输出、代码更改记录。 成员函数体注释给出函数控制结构、功能流程等 注释编写格式参见“注释编写”部分。 成员变量 使用m_开头，尽量使用完整的英文描述，如m_firstName、m_grandTotal等，而不是使用x1、y1之类的名字；另一种是使用Hungarian命名法，如m_sFirstName、m_iZipCode等 我们对变量要求使用Hungarian命名法。标准如下： i short类型 例:short iCount; n int类型 例:int nCount; l long类型 例:long lDataCount; f float类型 例:float fDataCount; d double类型 例:double dDataCount; c char类型 例:char cInKey; s 字符串类型 例:char sName[20]; p 指针类型 例:char *pMemAddr; st 结构类型 例:ParamStruct stMystruct; a 数组类型 例:int anMyArray[20]; g 全局变量 例:char gcSysComm; o 对象类型 例:CTreeClass oTreeClass; 注意变量大小写搭配 变量名不要太长（15） 避免使用仅在大小写上有差别的变量名，如m_firstName和m_firstname 对于组件变量，命名以组件名为后缀，并能描述出该组件的使用目的。如okButton、cancelButton、fileMenu，而不是button1, button2等。参见资源定义。 成员变量的注释 成员变量的注释应该包括：使用描述、所有可满足的不变式（这个较难） 局部变量 尽量使用完整的英文描述，如firstName、grandTotal等，而不是使用x1、y1之类的名字；另一种是使用Hungarian命名法，如sFirstName、iZipCode等 注意变量大小写搭配 变量名不要太长（15） 避免使用仅在大小写上有差别的变量名，如firstName和firstname 参数 参数命名同局部变量 类、接口等 在C++中，类命名以C开头，如CKernel等。 类的定义应该尽量减小public和protected接口。 类的注释（放在类头） 类功能描述、类的更改记录、不变量（较难） 注释的编写 注释应该简明，中英文不限 注释尽量不要跟代码放在同一行，变量定义部分例外。 文件头的注释：在新建立一个文件时，在文件头加入如下注释： /* * $Log$ */ 以利用CVS来跟踪代码更新历史。 由于现在不是采用CVS做版本管理，故文件头格式规定如下： /********************************************************* * 文件名 : * 文件功能 : * 编程者 : SUI/ * 日期 : * 项目名 : * 操作系统 : Windows98 * 履历 : * 编号----日期--------注释------------------------------- * 00 97.06.19 初期作成