不说废话,大牛初始亦菜鸟,成功之路贵执行,马上行动!如果想获得更优质的显示效果,请在Chrome、Firefox等现代浏览器浏览本站。

团队项目开发”编码规范”之三:程序注释

:: 挨踢业界 EricHu 718℃ 0评论

团队项目开发”编码规范”之三:程序注释 

发布日期:2011318星期三作者:EricHu

  勤能补拙、笨鸟先飞。

3.1  注释概述

1、修改代码时,总是使代码周围的注释保持最新。

2、在每个例程的开始,提供标准的注释样本以指示例程的用途、假设和限制很有帮助。注释样本应该是解释它为什么存在和可以做什么的简短介绍.

3、避免在代码行的末尾添加注释;行尾注释使代码更难阅读。不过在批注变量声明时,行尾注释是合适的;在这种情况下,将所有行尾注释在公共制表位处对齐。

4 、避免杂乱的注释,如一整行星号。而是应该使用空白将注释同代码分开。

5 、避免在块注释的周围加上印刷框。这样看起来可能很漂亮,但是难于维护。

6 、在部署发布之前,移除所有临时或无关的注释,以避免在日后的维护工作中产生混乱。

7 、如果需要用注释来解释复杂的代码节,请检查此代码以确定是否应该重写它。尽一切可能不注释难以理解的代码,而应该重写它。尽管一般不应该为了使代码更简单以便于人们使用而牺牲性能,但必须保持性能和可维护性之间的平衡。

8 、在编写注释时使用完整的句子。注释应该阐明代码,而不应该增加多义性。

9 、在编写代码时就注释,因为以后很可能没有时间这样做。另外,如果有机会复查已编写的代码,在今天看来很明显的东西六周以后或许就不明显了。

10 、避免多余的或不适当的注释,如幽默的不主要的备注。

11 使用注释来解释代码的意图。它们不应作为代码的联机翻译。

12 注释代码中不十分明显的任何内容。

13 、为了防止问题反复出现,对错误修复和解决方法代码总是使用注释,尤其是在团队环境中。

14 、对由循环和逻辑分支组成的代码使用注释。这些是帮助源代码读者的主要方面。

15 、在整个应用程序中,使用具有一致的标点和结构的统一样式来构造注释。

16 、用空白将注释同注释分隔符分开。在没有颜色提示的情况下查看注释时,这样做会使注释很明显且容易被找到。

17 、在所有的代码修改处加上的注释。

18 、为了是层次清晰,在闭合的右花括号后注释该闭合所对应的起点。

    namespace Langchao.Procument.Web

{

} // namespace Langchao.Procument.Web

3.2          文件注释

在每个文件头必须包含以下注释说明

// 文件名.cs” company=”HP”>

//  Copyright (c) HP. All rights reserved.

//

// ×××

// yyyy-mm-dd

//

文件功能描述

//

//      修改人:×××

//      修改时间:yyyy-mm-dd

//      修改描述:×××

//      版本:1.0

//

注意:文件功能描述只需简述,具体详情在类的注释中描述。创建标识和修改标识由创建或修改人员的拼音英文名。如:Zhangsan。一天内有多个修改的只需做一个在注释说明中做一个修改标识就够了。在所有的代码修改处加上修改标识的注释。

3.3          文档型注释

 该类注释采用.Net已定义好的Xml标签来标记,在声明接口、类、方法、属性、字段都应该使用该类注释,以便代码完成后直接生成代码文档,让别人更好的了解代码的实现和接口。如

1、   类、接口注释

///

    /// 类功能的说明

    ///

    ///

    ///

    /// 创建人:Zhangsan

    /// 创建日期:yyyy-mm-dd

    /// 修改人:Lisi

    /// 修改日期:yyyy-mm-dd

    /// 修改备注:无

    /// 版本:1.0

    ///

    public class CountersModuleInitializer : ModuleInitializer

    {

}

注意:标签根据具体情况选择有无

 

2、   方法、事件注释

///

        /// 根据员工编号获得员工信息

        ///

        /// 员工编号

        /// 系统异常

        /// 员工姓名

        ///

        /// 创建人:Zhangsan

        /// 创建日期:yyyy-mm-dd

        /// 修改人:Lisi

        /// 修改日期:yyyy-mm-dd

        /// 修改备注:无

        /// 版本:1.1

        ///

        public string GetEmployeeNameById(int employeeId)

        {

            try

            {

                return “ddd”;

            }

            catch (System.Exception)

            {

                throw;

            }

}

注意:该方法注释中的 等标签根据具体情况选择有无,方法初始版本为1.0,每次改动增加0.1

 

3、   属性、常量注释

///

        /// session id

        ///

public const string SESSION_ID = “”;

3.3  单行注释

      该类注释用于

1 方法内的代码注释。如变量的声明、代码或代码段的解释。注释示例:

         // 注释语句

         private int number;

    

          2 方法内变量的声明或花括号后的注释, 注释示例

if ( 1 == 1)    // always true

                {

                  statement;

                   }

                   else     // always false

                   {

}

3.4 JavaScript注释

     a) 注释符号

        //

        不允许使用‘/**/’作注释符。

    b) 函数注释

每个函数都应该描述该函数的名称、功能、作用范围、入口参数的类型和传值方式及参数含义、返回值类型及返回值的含义。格式如下:

//

//Function:  函数名

//Purpose:   用途

//Scope:     作用范围

//Args:      入口参数(列表)     类型传值方式含义

//Returns:   返回值类型  (可确定值列表)  含义

//

c) 非函数注释

   注明该模块的作用

   格式如下:

//

//功能:

//

d) 程序行间注释

   在程序行的每一个处理单元前作注释

   格式如下:

   //注释

e) 注释举例

     //

//Function:  F_FindObject

//Purpose:   按照空间名在可视化主对象中查找住对象内的可视化控件

//Scope:     Public

//Args:      is_name        String   value:要查找的空间名

//           ipbo_object    Object   value: 可视化主对象

//Returns:   Boolean        True     表示找到该控件

//                          False    表示没有找到该控件

//

function F_FindObject(is_name, ipbo_object) {

 

    //获得显示学生信息的GreeView控件

    var gv_student = document.getElementById(“GVStudent”);

   

    ***********

   

    //返回true

    return true;

}

3.5  注释标签

    

标签

用法

作用

c>text

 

text 希望将其指示为代码的文本。

为您提供了一种将说明中的文本标记为代码的方法。使用 将多行指示为代码

content

content段落文本。

用于诸如 等标记内,使您得以将结构添加到文本中。

name'>description

name 为方法参数名。将此名称用单引号括起来 (' ')

应当用于方法声明的注释中,以描述方法的一个参数。

 

name"/>

name

要引用的参数名。将此名称用双引号括起来 (" ")

标记为您提供了一种指示词为参数的方法。可以处理 XML 文件,从而用某种独特的方法格式化该参数。

cref="member"/>

 

cref = "member" 对可以通过当前编译环境进行调用的成员或字段的引用。编译器检查到给定代码元素存在后,将 member 传递给输出 XML 中的元素名。必须将 member 括在双引号 (" ") 中。

使您得以从文本内指定链接。使用 指示希望在请参阅一节中出现的文本。

cref="member"/>

cref = "member" 对可以通过当前编译环境进行调用的成员或字段的引用。编译器检查到给定代码元素存在后,将 member 传递给输出 XML 中的元素名。必须将 member 括在双引号 (" ")

使您得以指定希望在请参阅一节中出现的文本。使用 从文本

description

description

代码示例的说明。

使用 标记可以指定使用方法或其他库成员的示例。一般情况下,这将涉及到 标记的使用。

content

content 为希望将其标记为代码的文本。

 

记为您提供了一种将多行指示为代码的方法。使用 指示应将说明中的文本标记为代码



description

此处description 为对象的摘要。

应当用于描述类型成员。使用 以提供有关类型本身的信息。

cref="member">description

cref = "member" 对可从当前编译环境中获取的异常的引用。编译器检查到给定异常存在后,将 member 转换为输出 XML 中的规范化元素名。必须将 member 括在双引号 (" ") 中。

description 说明。

标记使您可以指定类能够引发的异常。

filename' path='tagpath[@name="id"]' />

filename 包含文档的文件名。该文件名可用路径加以限定。将 filename 括在单引号中 (' ')

Tagpathfilename 中指向标记名的标记路径。将此路径括在单引号中 (' ')

name 注释前边的标记中的名称说明符;名称具有一个 id

id

位于注释之前的标记的 id。将此 id 括在双引号中 (" ")

标记使您得以引用描述源代码中类型和成员的另一文件中的注释。这是除了将文档注释直接置于源代码文件中之外的另一种可选方法。

标记使用 XML XPath 语法。有关自定义 使用的方法,请参阅 XPath 文档。

  

      term

      description

  

  

      term

      description</description>

  

 

term  定义的项该项将在 text 中定义。

description  目符号列表或编号列表中的项或者 term 的定义。

块用于定义表或定义列表中的标题行。定义表时,只需为标题中的项提供一个项。

列表中的每一项用 块指定。创建定义列表时,既需要指定 term 也需要指定 text。但是,对于表、项目符号列表或编号列表,只需为 text 提供一个项。

列表或表所拥有的 块数可以根据需要而定。

cref="member">description

 

cref = "member" 对可以通过当前编译环境进行调用的成员或字段的引用。编译器检查到给定代码元素存在后,将 member 转换为输出 XML 中的规范化元素名。必须将 member 括在双引号 (" ") 中。

description  成员的访问的说明。

标记使您得以将成员的访问记入文档。System.Security.PermissionSet 使您得以指定对成员的访问。

description

description 成员的说明。

标记是可以指定有关类或其他类型的概述信息的位置。

是可以描述该类型的成员的位置。

description

description 返回值的说明。

标记应当用于方法声明的注释,以描述返回值。

property-description

property-description 属性的说明。

标记使您得以描述属性。请注意,当在 Visual Studio .NET 开发环境中通过代码向导添加属性时,它将会为新属性添加

标记。然后,应该手动添加 标记以描述该属性所表示的值。

转载请注明:RDIFramework.NET » 团队项目开发”编码规范”之三:程序注释

喜欢 (0)or分享 (0)
发表我的评论
取消评论

表情

Hi,您需要填写昵称和邮箱!

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址