windows程序设计基础(第一章)——1.4代码规范( 五 )

说明:

(1)每行字符不得超出80个字符(“/”加上“=”的总长度为80个字符;

(2)“NAME”为类的名称;

(3)“LIST”为实现的内部方法(函数)列表,并进行说明;

(4)“AUTHOR”为作者信息,需要时间的写法;

(5)“VERSION”为版本信息,版本说明见“1.4.7章节 关于版本控制”;

(6)“NOTE”为本文件中存在的程序功能进行说明。

函数开头的注释模板:

//-----------------------------------------------------------------------------// FUNC : XX函数//-----------------------------------------------------------------------------// IN : 变量1,变量1功能的说明;// 变量2,变量2功能的说明;// 变量n,变量n功能的说明;// OUT : void// RETURN : void// AUTHOR : 2012-2-6 11:18 Create by lixinghua for functions.// NOTE : 此函数实现了XX功能,其中调用了XX函数。//-----------------------------------------------------------------------------//

推荐阅读