一.开发工具规范:

1. 开发工具经项目负责人调试后统一确定。
2. 开发工具一经确定不允许集成任何非统一插件,若有需要,经项目负责人同意后统一为 项目组成员添加。
3. 开发工具的编码格式不允许修改。
二.排版规范:
1. 关键词(或变量)和操作符之间加一个空格。 例如:int iCont = 1;//操作符和值之间有一个空格。
2. 相对独立的代码块与块之间加空行。 例如:两个方法之间需要用空格隔开。
3. 较长的语句、表达式等要分成多行书写。
4. 长表达式要在低优先级操作符处划分新行,操作符放在新行之首。
5. 代码的新行与上一行根据逻辑关系要进行适应的缩进(一个 table 键),使排版整齐,语 句易读。
6. 不允许把多个短语句写在一行中,即一行只写一条语句。
7. 函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格。采用 TABLE 键缩进。
8. 循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分。
9. 若函数或过程中的参数较长,则要进行适当的划分。
10. 用大括号‘{'和‘}'界定一段程序块时,编写程序块时‘{'和 ‘}'应各独占一行 并且位于同一列,同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、 枚举的定义以及 if、for、do、while、switch、case 语句中的程序都要采用如上的缩进方 式。
JAVA代码开发规范(WISHSOFT)
11. main 方法:如果 main(String[]) 方法已经定义了, 那么它应该写在类的底部.
三.命名规范:
1. Package(包)的命名
Package 的名字应该都是由一个小写单词组成。 例如:package com.wish;
2. Class 的命名
Class 的名字必须由大写字母开头而其他字母都小写的单词组成,对于所有标识符,其
中包含的所有单词都应紧靠在一起,而且大写中间单词的首字母。 例如:
public class DatabaseOperator {
}
3. Class 中成员变量的命名 变量的名字必须用一个小写字母开头,后面的单词用大写字母开头,不需要数据类型前
缀。 例如:userName,size。
4. Class 中 Static Final 变量的命名
static Final 变量的名字应该都大写,并且指出完整含义。
例如:
public static final String DB_CONFIG_FILE_PATH ="com.neu.etrain.dbconfig";
5. Class 中方法的命名 方法的名字开头的单词必须用一个小写字母,后面的单词用大写字母开头。 例如:setName() , getMethod()。
6. 方法声明中参数命名 使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名字。 例如:
public void setCounter(int size)
{
JAVA代码开发规范(WISHSOFT)
this.size = size;
}
7. 方法内变量的命名
Class 中成员变量的命名。
8. 数组的命名
数组应该总是用下面的方式来命名: byte[] buffer;而不是: byte buffer[];
9. 分页中每页列表数量的变量使用 pageSize,当前的所在的页号为 pageNumber。
四.注释规范:
1. 注释要简单明了。
2. 边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。
3. 在必要的地方注释,注释量要适中。注释的内容要清楚、明了,含义准确,防止注释二 义性。保持注释与其描述的代码相邻,即注释的就近原则。
4. 变量、常量的注释应放在其上方相邻位置或右方,不可放在下面。
5. 全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存 取时注意事项等的说明。
6. 类,方法的注释采用 eclipse 自动生成方法。
当把一个类,或方法的声明写完整后,在类,方法的正上方(不许有空格)在英文输入 法状态下输入:/** 后,系统会自动生成他们的注释模板,我们只需要填写相应的说明文字 即可,注意:/**的下一行一定要写功能说明。
7. 具体要求说明:
n 声明性(变量定义类)一定要有注释。例如:String myName; //用户名 n 类定义必须生成文档(JavaDoc)注释。
n 方法必须生成文档(JavaDoc)注释(包括实体类的set,get方法)。 n 成员变量必须生成文档(JavaDoc)注释。
n 方法中的逻辑部分由程序编写人根据复杂情况自行书写。
8. 类定义的注释信息,包括:作者;日期;模块功能描述(如功能、主要算法、内部各部
分之间的关系、该文件与其它文件关系等);本文件历史修改记录;版本信息等。
/**
* 干什么用的(描述信息)
JAVA代码开发规范(WISHSOFT)
* @author lifw20080320
* @modify lifw20080321
* @modify lifw20080322 (如果有多个,依次写多个@modify) * @copyright wishsoft
**/
9.javadoc 注释标签语法
@author 对类的说明 标明开发该类模块的作者
@version 对类的说明 标明该类模块的版本
@see 对类、属性、方法的说明 参考转向,也就是相关主题 @param 对方法的说明 对方法中某参数的说明
@return 对方法的说明 对方法返回值的说明
@exception 对方法的说明 对方法可能抛出的异常进行说明
五.基本数据类型前缀表(其他对象类型,随时补充):
|
Java 中数据类型 |
数据类型前缀 |
|
int |
i |
|
String |
str |
|
char |
c |
|
long |
l |
|
float |
f |
|
double |
d |
|
boolean |
b |
|
short |
s |
|
byte |
byte |
|
vector |
v |
六.日志组件使用规范(log4j)
1. Log 中的方法使用:
a) log.debug()是放在代码行中间,用来调试时输出使用,永久保留,不用删除。
b) log.error()是放在 try{}catch(){}中 catch 部分里的用来输出 error 异常信息使用的。
以上就是本文的全部内容,希望本文的内容对大家的学习或者工作能带来一定的帮助,同时也希望多多支持!
# java开发规范
# java代码规范
# 养成良好java代码编码规范
# Java代码注释规范(动力节点整理)
# 8种常见的Java不规范代码
# Java代码注释规范详解
# JAVA代码书写规范汇总详解
# 关键词
# 放在
# 多个
# 开发工具
# 较长
# 都要
# 文档
# 若有
# 写在
# 自动生成
# 则要
# 项目负责人
# 他们的
# 不需要
# 是由
# 要有
# 要在
# 每页
# 对其
# 英文
相关文章:
如何在IIS中新建站点并配置端口与IP地址?
建站主机是否属于云主机类型?
临沂网站制作企业,临沂第三中学官方网站?
音响网站制作视频教程,隆霸音响官方网站?
详解免费开源的.NET多类型文件解压缩组件SharpZipLib(.NET组件介绍之七)
C++中的Pimpl idiom是什么,有什么好处?(隐藏实现)
,石家庄四十八中学官网?
如何快速搭建高效香港服务器网站?
北京网站制作网页,网站升级改版需要多久?
香港服务器WordPress建站指南:SEO优化与高效部署策略
在线ppt制作网站有哪些软件,如何把网页的内容做成ppt?
电商网站制作多少钱一个,电子商务公司的网站制作费用计入什么科目?
兔展官网 在线制作,怎样制作微信请帖?
如何快速查询网站的真实建站时间?
如何批量查询域名的建站时间记录?
建站VPS推荐:2025年高性能服务器配置指南
如何零基础在云服务器搭建WordPress站点?
如何彻底删除建站之星生成的Banner?
如何快速搭建支持数据库操作的智能建站平台?
建站之星好吗?新手能否轻松上手建站?
香港服务器租用费用高吗?如何避免常见误区?
如何规划企业建站流程的关键步骤?
如何快速搭建高效服务器建站系统?
百度网页制作网站有哪些,谁能告诉我百度网站是怎么联系?
已有域名能否直接搭建网站?
如何挑选优质建站一级代理提升网站排名?
网站制作公司排行榜,四大门户网站排名?
上海网站制作网页,上海本地的生活网站有哪些?最好包括生活的各个方面的?
如何通过IIS搭建网站并配置访问权限?
如何选择美橙互联多站合一建站方案?
如何通过虚拟机搭建网站?详细步骤解析
linux top下的 minerd 木马清除方法
如何用5美元大硬盘VPS安全高效搭建个人网站?
专业网站设计制作公司,如何制作一个企业网站,建设网站的基本步骤有哪些?
商务网站制作工程师,从哪几个方面把握电子商务网站主页和页面的特色设计?
如何快速完成中国万网建站详细流程?
网站建设制作需要多少钱费用,自己做一个网站要多少钱,模板一般多少钱?
Python路径拼接规范_跨平台处理说明【指导】
如何做网站制作流程,*游戏网站怎么搭建?
如何在沈阳梯子盘古建站优化SEO排名与功能模块?
建站之星展会模板:智能建站与自助搭建高效解决方案
制作网站的基本流程,设计网站的软件是什么?
,网站推广常用方法?
如何配置FTP站点权限与安全设置?
建站之星北京办公室:智能建站系统与小程序生成方案解析
,sp开头的版面叫什么?
如何选购建站域名与空间?自助平台全解析
如何登录建站主机?访问步骤全解析
头像制作网站在线观看,除了站酷,还有哪些比较好的设计网站?
如何选择高效便捷的WAP商城建站系统?
*请认真填写需求信息,我们会在24小时内与您取得联系。