项目开发规范V01.docx
《项目开发规范V01.docx》由会员分享，可在线阅读，更多相关《项目开发规范V01.docx（11页珍藏版）》请在冰豆网上搜索。
项目开发规范V01
项目开发规范
修订历史记录
日期
版本
说明
作者
目录
项目代码开发规范手册1
修订历史记录2
1项目目录规范4
1.1Java源文件目录4
1.2Web应用程序目录4
1.3Maven目录5
1.4SpringBoot目录5
2Java代码规范5
2.1命名规范5
2.2代码格式6
2.3注释7
2.4URI设计原则7
3前端代码规范8
3.1命名规范8
3.2代码规范10
4文档规范13
5其他规范15
5.1Svn源码提交15
5.2限制session的使用15
5.3限制外部包的使用15
【张三补充】15
1项目目录规范
1.1Java源文件目录
目录名
说明
src
（Java源代码）
|_com
域名倒置
|_inspur
公司名
|_common
公用包
|_util
工具包
|_db
数据库访问类
|_…
其他公用包
|_模块名
模块功能实现包
|_dao
数据库访问接口包
|_impl
数据库访问实现类包
|_service
模块业务接口包
|_impl
模块业务实现类包
|_controller
模块专用controller类包
1.2Web应用程序目录
目录名
说明
webpage
（Web页面源代码）
|_images
页面图片
|_js
Javascript源代码
|_css
样式表文件
|_admin
系统管理功能
|_模块名
系统管理模块功能实现页面
|_模块名
业务模块功能实现页面
|_WEB-INF
web.xml等文件存放目录
|_classes
Java类class文件目录
*.properties|*.xml
配置文件
|_lib
应用程序所需类包
|_config
系统配置信息
1.3Maven目录
待补充
1.4SpringBoot目录
待补充
2Java代码规范
2.1命名规范
（1）package的命名
由小写单词组成，例如：
mon。
包命名规则见目录规范
（2）Class的命名
Class的名字必须由大写字母开头，例如：
Person
（3）变量的命名
变量的名字必须由小写字母开头，后面的单词用大写字母开头，例如：
inputFileSize
（4）静态变量的命名
staticfinal变量的名字应该都大写，并且指出完整含义，例如：
MAX_UPLOAD_FILE_SIZE=1024
（5）参数的命名
参数的名字必须和变量的命名规范一致。
使用有意义的参数命名，尽量使用和要赋值的字段一样的名字。
如：
setSize（intsize）
{
this.size=size;
}
（6）数组的命名
数组应该用下面的方式来命名：
byte[]buffer;
而非：
bytebuffer[];
（7）方法的命名
方法的命名以小写字母开头，后面的单词用大写字母开头，例如：
inputFile（）
2.2代码格式
（8）文件头声明
源文件的头部需要一个history段，对于每次对源文件的重大改动，都需要在history段中注明。
该段定义在package和import之间，例如：
／*****************************************************
*HISTORY
*2017/08/01Biz创建文件
*2007/08/02kevin增加XX功能
*2007/08/10ben增加xx功能
*******************************************************/
（9）类和方法定义，例如：
publicclassCounterSet
extendsObservable
implementsCloneable
privatePortletSetgetPortlets（Portletsportlets,
RunDatarundata,
booleanapplication,
booleanapplicationsOnly）
{
}
（10）HQL/SQL语句
代码中书写的sql语句要求sql关键字全部大写，表名和字段名小写。
例如：
SELECTuser_id,nameFROMaccountWHEREuser_id>?
ANDdepart=?
ORDERBYname
2.3注释
（11）public和protected的成员变量和方法必须写javadoc注释。
对于代码中的逻辑分支或循环条件需要书写注释，例如：
if（somecondition）
{
//符合某个条件，应该这样处理
}
else
{
//否则应该那样处理
}
2.4URI设计原则
（12）URI的末尾不要添加“/”
多一个斜杠，语义完全不同，究竟是目录，还是资源，还是不确定而多做一次301跳转
负面case：
正面case：
（13）使用“-”提高URI的可读性
目的是使得URI便于理解，用“-”来连接单词
正面case：
（14）禁止在URL中使用“_”
目的是提高可读性，“_”可能被文本查看器中的下划线特效遮蔽
负面case：
别争，看到效果就明白了
（15）禁止使用大写字母
RFC3986中规定URI区分大小写
负面case：
正面case：
（16）不要在URI中包含扩展名
应鼓励RESTAPI客户端使用HTTP提供的格式选择机制Acceptrequestheader
正面case：
一个case：
（17）建议URI中的名称使用复数
正面case：
负面case：
3前端代码规范
3.1命名规范
jsp与html文件名全部小写，并遵循如下的规范：
a.数据/内容显示页:
名词，多个单词用下划线分隔，要求能说明显示内容的信息，为避免冲突，可加上“_list”。
例如：
new_message.html或my_file_list.jsp
b.操作处理页
命名格式：
名词_下划线_动词，例如：
file_delete.jsp。
c.含frame页面