程序源代码注释规范

程序注释规范说明

程序注释规范应包括以下三方面：

一、文件头部注释

在代码文件的头部进行注释，这样做的好处在于，我们能对代码文件做变更跟踪。在代码头部分标注出创始人、创始时间、修改人、修改时间、代码的功能，这在团队开发中必不可少，它们可以使后来维护/修改的同伴在遇到问题时，在第一时间知道他应该向谁去寻求帮助，并且知道这个文件经历了多少次迭代、经历了多少个程序员的开发和修改。

样本：

/***************************************************** ** 作者：Liuchao

** 创始时间：2007-11-12

** 修改人：Liuchao

** 修改时间：2007-11-12

** 修改人：Liaochao

** 修改时间：2007-11-12

** 描述：

** 主要用于产品信息的资料录入，…

*****************************************************/

二、函数、属性、类等注释

请使用///三斜线注释，这种注释是基于XML的，不仅能导出XML制作帮助文档，而且在各个函数、属性、类等的使用中，编辑环境会自动带出注释，方便你的开发。以protected，protected Internal，public声明的定义注释都建议以这样命名方法。

例如：

///

/// 用于从ERP系统中捞出产品信息的类

///

class ProductTypeCollector

{

…

}

三、逻辑点注释

在我们认为逻辑性较强的地方加入注释，说明这段程序的逻辑是怎样的，以方便我们自己后来的理解以及其他人的理解，并且这样还可以在一定程度上排除BUG。在注释中写明我们的逻辑思想，对照程序，判断程序是否符合我们的初衷，如果不是，则我们应该仔细思考耀修改的是注释还是程序了…

四、变量注释

我们在认为重要的变量后加以注释，说明变量的含义，以方便我们自己后来的理解以及其他人的理解，并且这样还可以在一定程度上排除BUG.我们常用///三斜线注释。

/// 用于从ERP系统中捞出产品信息的类

class ProductTypeCollector

{

int STData;///

…

}