注释规范v1.0.docVIP

.Net注释规范 修订历史 版本 说明 编制 日期 目录 一、 注释规范的目标 4 二、 .Net注释 4 三、 公司注释规范说明 4 注释规范的目标 编码规范对于程序员而言尤为重要编码规范可以改善软件的可读性，可以让程序员尽快地理解新的代码如果将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误程序有两类注释：实现注释(implementation comments)和文档注释(document comments)。 注释应被用来给出代码的总括，并提供代码自身没有提供的附加信息。注释应该仅包含与阅读和理解程序有关的信息。在注释里，对设计决策中重要的或者不是显而易见的地方进行说明是可以的，但应避免提供代码中己清晰表达出来的重复信息。多余的注释很容易过时。通常应避免那些代码更新就可能过时的注释。 注释不应写在用星号或其他字符画出来的大框里。注释不应包括诸如制表符和回退符之类的特殊字符。// =================================================================== // File: ModuleService.cs // Desc: 模块管理类。 // // Called by: // // Auth: 谢亮 // Date: 2010-07-20 // =================================================================== // Change History // =================================================================== // Date: Author: Description: // -------- -------- ------------------- // // =================================================================== // Copyright (C) 2010-2012 Powerrich Corporation // =================================================================== 格式说明： 项目 规则 备注 起始行 //=== 该行不允许再有其他内容 说明行 // 说明内容 说明行中对该类的功能进行说明，可以有多个说明行 作者行 Auth姓名，Date 时间 如果有多名作者，则分写几个作者行，类创建者在第一个作者行 版本行 修改历史记录 对类或者接口修改的历史记录，详细记录了时间，修改人和修改内容。 方法注释使用如下格式： #region 方法的详细使用说明 /// summary /// 类方法的详细使用说明 /// /summary /// param name=oRequestForm/param /// returns/returns /// exception cref=/exception /// see cref=/ 方法代码.. #endregion 格式说明： 项目 类型 规则 备注 说明行 必选 summary说明内容 说明行中对该方法的功能进行说明，可以有多个说明行 参数行 可选 param 参数 参数说明 一行对一个参数进行说明，可以有多个参数行。如果该方法没有任何参数，此项可省略。 返回行 可选 returns 返回结果说明 对方法的返回结果进行详细说明，只允许有一个返回行，但是可以折行。 如果该方法没有返回，此项可省略。 举例说明： #region 对动态服务的维护 /// summary /// 对动态服务的维护 /// /summary /// param name=oRequestForm/param /// returns/returns public ResponseForm oper