文档介绍：Net代码编写规范
Net代码编写规范
Net代码编写规范
１目的
　为了统一公司软件开发的设计过程中关于代码编写时的编写规范和具体开发工作时的编程规范，保证代码的一致性，便于交流和维护,特制定此规范。
2 范围
本规范适用于开发组全体人员，作用于软件项目开发的代码编写阶段和后期维护阶段。
3 注释规范
３．1 概述　
注释建议使用英文及英文的标点符号.
注释中，应表明对象的完整的名称及其用途，但应避免对代码过于详细的描述。
每行注释的最大长度为100个字符。
不允许给注释加外框。
编码的同时书写注释。
重要变量必须有注释.
变量注释和变量在同一行，所有注释必须对齐，与变量分开至少两个“Taｂ”键。
典型算法必须有注释.
在循环和逻辑分支地方的上行必须就近书写注释。
程序段或语句的注释在程序段或语句的上一行。
在代码交付之前，必须删掉临时的或无关的注释.
为便于阅读代码,每行代码的长度应少于１00个字符。
Net代码编写规范
Net代码编写规范
Net代码编写规范
3。2 自建代码文件注释
　　对于自己创建的代码文件（如函数、脚本)，在文件开头,一般编写如下注释:ﻫ　　 /*＊＊＊**＊＊＊＊*＊*＊＊＊＊＊*＊＊＊＊＊＊＊*＊*＊*＊＊＊*＊*＊＊*＊＊＊**＊＊＊＊＊*＊*＊    ﻫ 　 :
　　Copｙriｇht  （c)  ２０0４—xxxx ＊＊***＊＊**公司技术开发部
Writeｒ：
　 create Date：ﻫ Ｒewrｉｔer：
　 Rewrite Daｔe：ﻫ 　　Impact：ﻫ 　 Maｉn　Conｔｅnt(FｕnctiｏｎＮａme、parameters、rｅｔuｒｎs)ﻫ    *＊***＊＊*＊＊＊****＊**＊＊＊*＊＊*＊＊＊＊＊＊*****＊*******＊＊＊*＊**＊＊＊/
 模块(类）注释
模块开始建议使用以下形式书写模块注释:
　　/／/＜sumｍａｒy〉
  ／//Module ID:＜模块编号，可以引用系统设计中的模块编号〉ﻫ  //／Deｐｉctiｏn：＜对此类的描述，可以引用系统设计中的描述＞
  ///Author：作者中文名 ﻫ  ／//Creaｔe　Date：〈模块创建日期,格式:YYYY-MM-ＤD＞
  ／//＜/summaｒy>
如果模块只进行部分少量代码的修改时，则每次修改须添加以下注释:
　 ///Ｒewriter:    
///Rｅwrｉtｅ Datｅ：<修改日期，格式：YYYY—MＭ—ＤD〉  Sｔart1：        
/＊原代码内容＊/
　 ///Ｅｎd1：                               
将原代码内容注释掉，然后添加新代码使用以下注释：ﻫ /／/Adｄed　by：    
///Aｄd datｅ：＜添加日期，格式： YＹＹY－MM-ＤＤ>   Ｓtart2：       
　新代码内容ﻫ　　///End2：      
如果模块输入输出参数或功能结构有较大修改，则每次修改必须添加以下注释：ﻫ 　//／<suｍmａrｙ〉
  /／／Ｌｏg ID：<Lｏｇ编号，从１开始一次增加＞
Net代码编写规范
Net代码编写规范
Net代码编写规范
ﻫ  /／/depｉction:<对此修改的描述>ﻫ  ///Wriｔer：修改者中文名
  ///Ｒｅwrite Datｅ：〈模块修改日期，格式：YYYY－ＭM-DD〉
  ／//</sumｍary〉
 类属性注释
在类的属性必须以以下格式编写属性注释:
  /／/ ＜sｕmmary〉ﻫ  ///　〈Pｒoperties depictｉon>
/// ＜／sｕｍmary〉
３。５ 方法注释
在类的方法声明前必须以以下格式编写注释ﻫ  /// ＜ｓummary>
  ///　ｄｅｐictioｎ：<对该方法的说明〉ﻫ  ／// 〈／summary〉ﻫ  /// ＜parａm　ｎａme=＂〈参数名称>”>＜参数说明〉＜／pａraｍ〉ﻫ  /// 〈returns>ﻫ  ///＜对方法返回值的说明,该说明必须明确说明返回的值代表什么含义〉
  /／/ </ｒetｕrｎs〉ﻫ  ///Writｅr:作者中文名ﻫ  ///CｒeatｅＤate：<方法创建日期,格式：ＹYYＹ—MＭ-DD＞  
 代码间注释
代码间注释分为单行注释和多行注释:ﻫ 单行注释:
/／<单行注释〉
 多行注释:
 /*多行注释1
 多行注释2ﻫ 多行注释3＊/ﻫ代码中