编码规范说明书.pdfVIP

编码规范说明书 一、 模块头部注释规范 以一个物理文件为单元的都需要有模块头部注释规范，例如：C# 中的.cs 文件。用于每个模 块开头的说明，主要包括以下几部分：（粗体字为必需部分，其余为可选部分） 1. 文件名称(File Name)： 此文件的名称 2. 功能描述(Description)： 此模块的功能描述与大概流程说明 3. 数据表(Tables)： 所用到的数据表，视图，存储过程的说明，如关系比较复杂，则 应说明哪些是可擦写的，哪些表为只读的。 4. 作者(Author)：创建人 5. 日期(Create Date)：创建时间 6. 参考文档(Reference)(可选)：该档所对应的分析文档，设计文檔。 7. 引用(Using) (可选) ﹕开发的系统中引用其它系统的Dll、对象时，要列出其对应的出 处，是否与系统有关﹙不清楚的可以不写﹚，以方便制作安装档。 8. 修改记录(Revision History)：若档案的所有者改变，则需要有修改人员的名字、修改 日期及修改理由。 9. 分割符：*************************** (前后都要) 示例如下： 二、方法注释规范 1 、类、接口、属性、方法必须有Summary节，另外方法如果有参数及返回值，则必须 有Param及Returns节。格式如下： /// summary /// … /// /summary /// param name=””/param /// returns/returns 示例如下： 2、公用类库中的公用方法需要在一般方法的注释后添加作者、日期及修改记录信息，统 一采用XML 标签的格式加注。 格式如下： Author/Author 作者 CreateDate/CreateDate 建立日期 RevisionHistory 修改记录 ModifyBy/ModifyBy 修改作者 ModifyDate/ModifyDate 修改日期 ModifyReason/ModifyReason 修改理由 ModifyBy/ModifyBy 修改作者 ModifyDate/ModifyDate 修改日期 ModifyReason/ModifyReason 修改理由 ModifyBy/ModifyBy 修改作者 ModifyDate/ModifyDate 修改日期 ModifyReason/ModifyReason 修改理由 /RevisionHistory LastModifyDate/LastModifyDate 最后修改日期 三、代码行注释规范 格式如下(双斜线)： // …………….. 示例如下： 四、变量注释规范 1、Class 级变量应以采用 /// 形式自动产生XML 标签格式的注释。 示例如下： 2、方法级的变量注释可以放在变量声明语句的后面，与前后行变量声明的注释左对齐， 注释与代码间以Tab 隔开。 示例如下： 五、命名规则 1、Package 的命名 Package 的名字应该都是由一个小写单词组成，按照以下格式对包进行命名： com.wiimedia.项目名称.大类名称.小类名称。 例如：mon。 2、Class 的命名 Class 的名字必须由大写字母开头而其他字母都小写的单词组成， 例如：DataFile 或InfoParser。 说明：对同一项目的不同命名空间中的类，命名避免重复。避免引用时