DotNet项目组编码规范.doc

4、注释关键代码必须加注释，简单说明其功能、设计思想、算法等等。长条注释（划分功能模块）、短条注释（说明实现的各步骤）与句后解释（说明重要句的意义）相结合，清晰功能的实现层次。如：//Drawthestringasnormalandletthentransformsdothework/*Thisisatest*/1)一般来讲，按需要来注释，简明扼要。2)修改代码的注释，当有第二人开始修改代码时，应在每一次修改的代码部分加以注释，必须包括修改人，修改时间，还可以包括修改目的等。8．其他要点1)对上述较长者在范围结束处加注释。如//for循环结束。2)注释必须简明扼要，规范易懂。二．对象的可

5、访问性设计1)不要随意定义类的public，这在基于组件的开发中相当重要。2)只有被其他类引用的函数才定义成public型函数。3)类中最好不用public型成员变量（一般使用属性来代替）。4)最好不使用全局变量。可以使用一些代替的方法。三．对象的命名规范1．命名要求1)所有命名（类、函数、变量..）均要求意义明确易于理解。2)避免在代码中直接使用数字等不确定意义的词，尽量使用有意义的串值代替。例子：ProtectedConststringCAPTION_TITLE="BindDatatoaComboBox"3)在名字上区分各种变量及函数。2．命名约定1)常量命名规则。一般用大写具有

6、意义的复合单词来定义。protectedConststringCAPTION_TITLE="BindDatatoaComboBox"2)字段（变量），开头将一小写字母开头，后面的具有意义的英语单词开始于大写。publicstringstrName等3)属性，一般用大写字母开头，要具有一定的意义。Name;4)类名，以大写字母开头的有意义的复合英语单词。对类名的定义还要考虑到该类的意义。比如我们在项目中分了商务规则层、数据层、商务界面层、数据访问层等。我在下面给出一个Agent表在各层中进行处理的时候相关的类的命名：AgentData--àAgentS--àAgentR--àAgent

7、F(分别是：数据实体、数据访问层、商务规则层、商务界面层的命名)5)控件的命名规则，控件的命名可以以控件的缩写开头（小写），配以一定意义的英文单词；尽量让缩写可以理解。遇到新的控件可以大家讨论来制定。比如：Button：btnUpateDropDownList:ddlstCityLabel:lblNameDataGrid:grdAgentDataList:dlstAgentTextBox:txtName(等等)6)文件名字的命名，以大写字母开头。DataA