开发规范总结(不断更新中...)
工作好几年了,经历过一些企业,同样也经历过大大小小的一些项目;总的来说,或多或少好是有些经验的积累,比如在开发规范方面。
话说不以规矩不能成方圆。每个公司都有自己的制度,但他们的规章制度都不尽一样,IT行业的开发规范也不例外。下面主要总结出一些在开发上的规范(主要是指C#),里面也可能会有反面的例子,但不代表现有企业的观点(当然不是批判,总得有例子说明问题嘛!)
1.命名规范
命名规则
使用Pascal或Camel规范来命名C#中的各种标识对象
文件与文件夹命名
文件命名一般能够代表此(明细)功能,当然也会存在一些全局的文件。Util,Common等;并且一般一个文件对应一个类
文件夹命名一般代表某类功能(模块,系统),可能也会存在公共的问价夹。如:Common,XXXBusiness等
命名空间命名
一般使用公司名称作为命名空间的根,只有可以是公司的某个产品,或者平台等。如果:Microsoft.Office等
接口命名
接口一般以字母"I"开头,以代表是接口加上代表这类功能的名词或名词短语。如:ISaveService;如果某类功能,借口名称本是"I"开头,也应该不受影响。如:IInvoice等。
类命名
字段命名
属性命名
方法命名
事件命名
委托命名
...
2.结构化代码规范
代码注释
格式化代码
3.其他
浙公网安备 33010602011771号