string m_strSql;            //SQL

i)       典型算法必须有注释。

j)           在循环和逻辑分支地方的上行必须就近书写注释。

k)           程序段或语句的注释在程序段或语句的上一行

l)       在代码交付之前，必须删掉临时的或无关的注释。

m)       为便于阅读代码，每行代码的长度应少于100个字符。

3.2      自建代码文件注释

对于自己创建的代码文件（如函数、脚本），在文件开头，一般编写如下注释：

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

FileName:

Copyright  (c)  2004-xxxx *********公司技术开发部

Writer:

create Date:

Rewriter:

Rewrite Date:

Impact:

Main Content（Function Name、parameters、returns）

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

3.3      模块（类）注释

模块开始必须以以下形式书写模块注释：

///<summary>

        ///Module ID：<模块编号，可以引用系统设计中的模块编号>

        ///Depiction：<对此类的描述，可以引用系统设计中的描述>

        ///Author：作者中文名

        ///Create Date：<模块创建日期，格式：YYYY-MM-DD>

        ///</summary>

如果模块只进行部分少量代码的修改时，则每次修改须添加以下注释：

///Rewriter：     Rewrite Date：<修改日期，格式：YYYY-MM-DD>  Start1：        

/* 原代码内容*/

///End1：                               

将原代码内容注释掉，然后添加新代码使用以下注释：

///Added by：     Add date：<添加日期，格式：YYYY-MM-DD>   Start2：       

新代码内容

///End2：                                

如果模块输入输出参数或功能结构有较大修改，则每次修改必须添加以下注释：

///<summary>

        ///Log ID：<Log编号,从1开始一次增加>

        ///depiction：<对此修改的描述>

        ///Writer：修改者中文名

        ///Rewrite Date：<模块修改日期，格式：YYYY-MM-DD>

        ///</summary>

3.4      类属性注释

在类的属性必须以以下格式编写属性注释：

        /// <summary>

        /// <Properties depiction>

/// </summary>

3.5      方法注释

在类的方法声明前必须以以下格式编写注释

        /// <summary>

        /// depiction：<对该方法的说明>

        /// </summary>

        /// <param name="<参数名称>"><参数说明></param>

            /// <returns>

            ///<对方法返回值的说明，该说明必须明确说明返回的值代表什么含义>

    /// </returns>

        ///Writer：作者中文名

        ///Create Date：<方法创建日期，格式：YYYY-MM-DD>

   &n

上一页  [1] [2] [3] [4] [5] [6] [7] [8] [9]  下一页