|
1.2 模块头部注释规范以一个物理文件为单元的都需要有模块头部注释规范，例如：C#中的.cs文件用于每个模块开头的说明，主要包括：（粗体字为必需部分，其余为可选部分）文件名称(File Name)： 此文件的名称功能描述(Description)： 此模块的功能描述与大概流程说明数据表(Tables)： 所用到的数据表，视图，存储过程的说明，如关系比较复杂，则应说明哪些是可擦写的，哪些表为只读的。作者(Author)：日期(Create Date)：参考文档(Reference)(可选)： 该档所对应的分析文档，设计文檔。引用(Using) (可选)﹕ 开发的系统中引用其它系统的Dll、对象时，要列出其对应的出处，是否与系统有关﹙不清楚的可以不写﹚，以方便制作安装档。修改记录(Revision History)：若档案的所有者改变，则需要有修改人员的名字、修改日期及修改理由。分割符：*************************** (前后都要) 1.3 方法注释规范1> C# 提供一种机制，使程序员可以使用含有XML 文本的特殊注释语法为他们的代码编写文档。在源代码文件中，具有某种格式的注释可用于指导某个工具根据这些注释和它们后面的源代码元素生成XML。具体应用当中，类、接口、属性、方法必须有节，另外方法如果有参数及返回值，则必须有及节。示例如下： /// /// … /// /// /// 2> 事件不需要头注解，但包含复杂处理时（如：循环/数据库操作/复杂逻辑等），应分割成单一处理函数，事件再调用函数。 3> 所有的方法必须在其定义前增加方法注释。 4> 方法注释采用 /// 形式自动产生XML标签格式的注释。
|