Boss3g 软件开发规范
命名规范制定意义
1 方便代码的交流和维护，便于日后自己的再次阅读。
2 不影响编码的效率，不与大众习惯冲突。
3 使代码更美观、阅读更方便。
4 使代码的逻辑更清晰、更易于理解
命名规范制定原则
首要原则
有意义的，描述性的词语来命名。能够一眼看出它作什么。别使用会引起误解的名字。如果名字一目了然，就无需用文档来解
释方法的功能了
1.除约定俗成的，别用缩写。用 name, address, salary 等代替 nam, addr, sal
2.除用于循环，别使用单个字母的变量象 i, n, x 等. 而要使用 index, temp 等。
for ( int i = 0; i < count; i++ ){ ...}
其他习惯
除了界面控件外，不要使用类型前缀。比如：使用名称 amount，而不是 intAmount；
类：使用名词、名词短语命名。比如：public class FileStream；
方法：使用动词、动词短语开始。比如：CreateUser(), RemoveAt()等；
接口：以 I 开始，后面加上名词、名词短语、形容词命名。比如：IDisposable；
常量：所有单词大写，多个单词之间用 "_" 隔开。public const string PAGE_TITLE = "Welcome";
命名空间： 基本格式：
CompanyName/ProjectName.TechnologyName[.Feature][.Design]
a) CompanyName/ProjectName：公司名、项目名称或产品名称；
b)TechnologyName：稳定的、公认的技术名称或架构层次名称；
c)[.Feature][.Design]：可选的功能与设计；
规范
1、用 pascal 规则来命名方法和类.(第一个单词首字母大写，后面连接的每个单词首字母都大写）
publicclassDataBase；publicvoidGetDataTable()
2、类：使用名词、名词短语命名。比如：public class FileStream；
2.用 camel 规则来命名局部变量和方法的参数.(第一个单词不大写，后面连接的单词首字母大写)
publicvoidAddUser(stringuserId,byte[]password)
{stringuserName;}
3.所有的成员变量前加前缀 _
publicclassDatabase
{privatestring_connectionString;}
4.接口的名称加前缀 I
interfaceICompare
{intcompare();}
5.自定义代码属性类以 Attribute 结尾
publicclassOperationAttribute:Attribute
6.自定义的异常以 Exception 结尾
第 1 页
评论0