开发规范与要求1
目的1)养成良好的编程习惯
2)写出清楚、易懂、易维护的程序代码
3)提高软件质量与生产率
4)减少软件编码中的不必要的错误
5)提供完整的软件产品编码和文档
要求1)必须严格执行本规范以确保源代码的可读性及可维护性
2)所有的程序文件都必须有注释文字,并严格按照本规范中的“注释规范”书写
3)编码必须使用标准英文单词,不允许使用中文拼音
4)如果有名词,必须使用单数形式
5)使用大小写混合格式,将连接的几个单词首字母大写,除常数变量和模块级变量(m_*)外避免使用下划线
6)命名必须在 3 至 20 个字母以内
7)尽量避免使用缩写,如果必须使用,请参考本规范附录的缩写范例
开发工作要求1)每天下班前必须签入所有代码,签入的代码必须是可编译通过的
2)每天早上必须获取全部最新 VSS
3)为项目添加后文件后必须立即签入项目,再把新建的文件签出进行编码
添加注释,注明创建时间、作者、功能,类的注释如下://////时间:2010-10-23Ill 作者:XXX///功能:用于枚举项的属性说明lll 更新记录:Ill1、2011-10-23,XXX,增加 Text 属性lllpublicclassTextAttribute:Attribute4)界面风格必须保持统一,如页面、css、按钮风格,位置等等5)文件目录,凡在 OA 基础上开发的项目,要用独立的目录存放,如 HR 在 OA基础上开发,建立 HR 独立的目录 HRWeb,并将 images
cssjs 等目录独立于 OA相关目录存放在该目录下
6)各模块下的模块目录,详细拆分到各子模块功能目录
7)文件命名采用主谓结构,首字母大写,文件和文件夹的名称应该精确地说明它们的用途,类名和文件名尽量保持完全相同
8)命名空间:命名空间参考具体开发产品的命名规则,一般由以下几部分构成:Part1:Li