l 版本: l 修改历史: l 读者: l 目的: l 归档情况: l 其他: 项目名称:XX 项目编号:项目代号: 项目版本:
1. 编码规范 a) 各种对象的命名规范: 类,接口,属性,方法,对象,变量,静态变量,包结构设计等等 b) 程序结构规范: Package package_name;
Import ….;
Class Class_Name extends BaseClass_Name implements Interface_Name{ Public static final Field Public Property Public Method
Private method Private static Var Private Var }
c) 一些常见的编码建议性原则: 提供注释 提供javadoc文档 2. 系统文件结构规范 Project_Home[\SubProject]\Module_Name[\SubModule]\Operation_File.jsp|Servlet_Name 3. 协同开发规范 提供模块对应jar文件,同时提供与前一个版本的 Change History Document,提供javadoc文档,提供类图文件,提供其它一些必要的说明文件。 4. 版本(代码文档)注释 a) 版本号的前后一致性原则 b) 格式: major.minor1.minor2[.minorn] c) 如果是协同开发: 可能需要在版本号前面加上ModuleName_Abbreviate作为Prefix