iB2Team项目开发规范By zxdtd 2016-4-20
仅供参考
1 .为了使软件开发过程顺畅,保证软件质量,有本开发规格书。
2 .概要项目由功能模块划分,分工数据库不能自由修改。 本地数据库必须统一标准的Java代码样式,习惯始终考虑代码复用性的人必须每周有项目进度报告3 .代码规范3.1用变量名命名,以了解变量的含义
3.1.1软件包命名以小写命名唯一的域名组件命名3.1.2类命名类命名以Pascal命名法大写字母开头, 将每个单词首字母大写的3.1.3方法命名方法为3358 www.Sina.3 boolean型属性的get方法例如是isproperty(3.1.4变量名为Camel命名法小写例如,SQL变量名称不能太长。 如果缩短英语元音字母和缩短长度,但存在名称重复,则可以保留部分元音
将所有字符大写的3.1.6页面文件命名为Camel命名法将所有字符小写,在单词之间用下划线’_’分隔页面,并用名词说明。 例如,用news_list.jsp操作页、名词动词命名。 例如,news_add.jsp,例如news_order_add.jsp 3.1.7资源文件命名基于全大写命名法前缀模块的描述状态进行命名。 例如,btn_main_login_pressed.png (不一定完全包括上述4
3.2.1程序文件的标头注释应包括:
*文件说明
*作者
*版本
*创建时间
*变更日期和时间
*参考信息
全小写命名法
以下模板:
/* *描述3360 * author : zxd TD * version :1.0 * create datetime 3360 $ { date } $ { time }.*更新数据3360
必须包括以下信息:
*方法说明Description:
*参数信息@param
*返回信息@return
*异常信息@Exception
*参考信息(可选) @see also //指定类或方法(在类后面加上#选择方法) )。
*备注信息(可选) Note:
以下模板:
/** * Description:投“Hello”字符串* @param str字符串* @return投字符串* @throws Exception投异常*@seecom.lidengju.entity 返回str; } 全小写命名法
3.2.3注释记号必须包含以下信息:
还有程序的重要之处
有些地方很难读程序
编写代码时发生问题的位置
*需要向读者提示的地方
注释应该写得少,通俗易懂
修改文件的情况下,可以添加修改者的信息和修改日期。
4 .请注意,格式规范4.1缩进使用格式设置代码格式,使用Tab键缩进代码。 相当于四个空间。
4.2换行符{}大括号必须是单独的行。 左大括号与方法名称、类名位于同一行。 即使体内只有一句代码,也不要省略(数组初始化时的大括号除外) if、while等语句。 )由于后面的添加/删除字符串太长,所以应该将类和方法对齐的块注释(如拆分为多行并对齐4.3 )必须与被注释语句对齐,以紧密接触类和方法并独立引起行//注释。 希望以后能遵守这个开发规格书,养成良好的开发习惯