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

编码规范 类成员函数 成员函数应该以完整的英文描述命名，函数名的第一个单词通常是一个动词。如openAccount、 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 初期作成 * 01 97.06.20 修改××× *********************************************************/ 履历部分现在可以不添，等版本基本稳定以后再处理。 想利用Doxygen提取出来的注释，使用以下注释方式： Qt Style: /*! 注释 */ 单行模式: //! 注释 JavaDoc Style: /** * 注释 */ 单行模式： /// 注释 我们的系统对注释要求使用JavaDoc模式。 Doxygen根据注释生成的文档包括两个部分：Brief和Detail. 在Qt Style中， //! A function variable. /*! Details of handler. */ int (*handler)(int a,int b); 单行模式的注释生成的是Brief部分的文档 而两个注释合并部分则生成Detail部分的文档。生成的文档如下： Brief部分： int (* handler )(int a,int b) A function variable. More... Details部分： int(* Test::handler)(int a,int b) A function variable. Details of handler. 在JavaDoc Style中： Doxygen把注释的第一句作为Brief注释。如 /** * a public variable. * Details of handle