文档介绍：软件开发规范(C#)文档名称软件开发规范初稿描述编写人员审核人版本日期文档变更历史时间修改人章节描述   ,保证代码的一致性,便于交流和维护,特制定此规范。,作用于软件项目开发的代码编写阶段和后期维护阶段。. 概述a)注释要求中文及中文的标点符号。b)注释中,应标明对象的完整的名称及其用途,但应避免对代码过于详细的描述。c)每行注释的最大长度为100个字符。d)将注释与注释分隔符用一个空格分开。e) 不允许给注释加外框。f) 编码的同时书写注释。g) 重要变量必须有注释。h) 变量注释和变量在同一行,所有注释必须对齐,与变量分开至少两个空格。如:    stringtitle;//标题i) 典型算法必须有注释。j) 在循环和逻辑分支地方的上行必须就近书写注释。k) 程序段或语句的注释在程序段或语句的上一行l) 在代码交付之前,必须删掉临时的或无关的注释。m) 为便于阅读代码,每行代码的长度应少于100个字符。 (类)注释模块开始必须以以下形式书写模块注释:///<summary>///说明:<对此类的描述,可以引用系统设计中的描述>///作者:作者中文名///创建时间:<格式:YYYY-MM-DD>///</summary>///修改记录:///2012-01-01修改人名称修改功能描述///2012-01-02修改人名称修改功能描述///2012-01-lassOrder{}  :///<summary>///属性说明///</summary>publicDateTimeAddTime;///<summary>///方法说明///</summary>///<paramname="orderInfo">参数说明</param>///<returns>对方法返回值的说明,该说明必须明确说明返回的值代表什么含义</returns>///修改记录:///2012-01-01修改人名称修改描述///2012-01-02修改人名称修改描述///2012-01-03修改人名称修改描述publicintAdd(OrderInfomodel){}:单行注释://<单行注释>多行注释:/*多行注释1多行注释2多行注释3*/或者//多行注释1//多行注释2//多行注释3代码中遇到语句块时必须添加注释(if,for,foreach,……),添加的注释必须能够说明此语句块的作用和实现手段(所用算法等等)。具体可参考XML文档注释(C#编程指南)http://msdn.//library/b2s063f7(v=).,是有意义的,描述性的词语。能够一眼看出它作什么。别使用会引起误解的名字。如果名字一目了然,就无需用文档来解释方法的功能了。名字尽量使用英文单词。名字尽量不使用缩写,除非它是众所周知的。名字可以有两个或三个单词组成,但不应多于三个,控制在3至30个字母以内。在名字中,多个单词用大写第一个字母(其它字母小写)来分隔。例如:IsSuperUser。名字尽量使用前缀而不是后缀。名字中的单词尽量使用名词,如有动词,也尽量放在后面。例如:FunctionUserDelete(而不是FunctionDeleteUser)。 在具体任务开发中,如果有特定的命名约定,则在相应的软件开发计划中予以明确定义及上报。://msdn.//library/xzf533w0(v=). 解释 例子 Pascal规则 首字母和后面的每个单词的首字母都大写;其他字母小写 HelloWorld Camel规则 首字母小写,而后面的每个单词的首字母大写;其他字母小写 helloWorld Upper规则 所有字母都大写,中间用下划线分隔 PI 标识符 命名格式 例子备注  标识符、参数、局部变量 Camel规则 publicintGetTypeID(stringtypeName){inttypeID;…}  Private、Protected的实例字段 Camel规则 privatestringredValue;prote