java代码书写规范
easyjava吧
全部回复
仅看楼主
level 11
xiao616483258 楼主

类的方法的代码行数不能过长,尽量控制在
100行(90%),长的方法要拆分成私有函数。
2013年03月28日 14点03分 1
level 11
xiao616483258 楼主
3.1
返回值:
在一般情况下,方法返回值不应返回null。而是尽量使用异常代替返回null。如果在特殊情况必须返回null, 必须在方法说明中加以特别说明,如使用“特别注意”等字样。例如:从一个集合类实例中提取一个对象,因为有些集合类实例是允许null作为键或值的,这个时候用异常取代返回null就不合适了。如果方法的返回值是集合类对象,而且返回的集合对象不包含任何元素时,则应返回0长度或0大小的集合对象。不能返回null。
2013年03月28日 14点03分 2
应该遵从谁使用谁负责的态度吧~~~~
2013年05月29日 02点05分
level 11
xiao616483258 楼主

3.2
异常
整个应用系统使用自行设计的唯一异常类,该类包括message(表示错误信息)和ID
号(整型,表示异常类型)两部分,该类在创建时是自动获得类名、方法名、行号等信息。在系统开发和上线之后的一段时间内,异常信息要直接发送到浏览器页面,以便于开发人员迅速定位错误。
2013年03月28日 14点03分 3
level 11
xiao616483258 楼主

3.3
表达式
1)所有的算术、逻辑表达式的每一项运算都需要加圆括号,避免使用java语言的运算符优先级,例如:
(2 *(x + y))/(1 - x);
((n > 1)?(n - 1):(n = 1))
result =(result && (lastOperand > nextOperand));
2)二元算术运算符(除去“/”)、二元逻辑元素符、赋值运算符,既“+、-、*、%、+=、-=、*=、/=、%=、>、<、==、>=、<=、=”等符号左右两边要加空格,例如:
if(lastOperand >= lastOperand)
3)参数说明部分的逗号“,”和for语句循环说明部分的分号“;”之前不需要留空格,之后需要留空格。如:
Calculator.add(int a, int b);
for(int i = 0; i < 100; i ++);
2013年03月28日 14点03分 4
level 11
xiao616483258 楼主

3.4体前代码
体前代码包括:
a)方法的参数说明和异常说明;
b)条件语句,如if语句、switch语句;
c)循环语句,如while语句、for语句。
这些语句的参数说明、条件说明和循环控制都放在圆括号内。如果不是特别长,应尽量放在同一行内。
同时注意,参数说明、条件说明和循环控制的结束圆括号“)”与体开始花括号“{”之间留一个空格。
2013年03月28日 14点03分 5
顶~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2013年05月29日 02点05分
level 11
xiao616483258 楼主

3.5注释
注释是软件可读性的具体体现。程序注释量一般占程序编码量的20%,软件工程要求不少于20%。以下是四种必要的注释:
(1)类说明注释
注释一般位于package/import 语句之前,class 描述之前。要求至少写出内容说明、创建者、创建时间和特别注意事项等内容。例如:
/**
* 名称: ${file_name}<br>
* 描述: <br>
* 类型: JAVA<br>
* 最近修改时间:${date} ${time}<br>
* @since ${date}
* @author 刘华
*/
(2)方法说明注释
对几乎每个方法都应有适当的说明,位于方法声明之前,包括:说明,参数说明、异常说明、返回值说明和特别说明等。例如:
/**
* 方法描述
*
* ${tags}
* @param id String唯一标识
* @param personid String 用户唯一标识
* @return rtobj BaseReturn 基本返回对象
* @变更记录${date} ${time} 刘 华 创建
*
*/
(3)体内代码的注释体(方法体、代码块体、静态代码块体等)内的代码按照功能分成多个虚拟的功能块,每个块以块注释“/* xxx */”注释开始,以空行结束;例如:
/**是否超级管理员**/
private Boolean isadmin = false;
if(null!=curOuId&&!curOuId. equals (“”))
{
/*组织机构ID不为空时 */
curOuId = „000000‟;
空行
}
空行
if(curOuId==null)
{
/*组织机构ID为空时*/
}
(4)行注释
行注释“//”仅用于调试注释,在程序稳定之后,行注释必须被删除,以免影响程序的可读性。
2013年03月28日 14点03分 6
[背扭]
2013年04月11日 09点04分
level 8
好~顶一个!
2013年03月28日 15点03分 7
[Love]
2013年03月28日 15点03分
level 11
xiao616483258 楼主
大家有好的经验也拿来分享!
2013年03月28日 16点03分 8
level 5
好东西,顶一个
2013年03月28日 22点03分 9
level 6
收藏了,很不错,养成习惯就好了
2013年03月29日 13点03分 10
level 11
xiao616483258 楼主
2013年03月29日 15点03分 11
level 4
总结的还不算太全面,希望后续可以完善。
——来自 诺基亚 Lumia 920
2013年03月31日 09点03分 12
如果你有兴趣也可以来完善的,我们大家共同学习~
2013年03月31日 13点03分
level 8
学习了
[Kiss]
2013年04月01日 06点04分 14
呵呵,回头我再优化一些,有吧友反映不够详细!
2013年04月01日 06点04分
level 5
[太好啦]
学习了
2013年04月01日 10点04分 15
level 9
很好,很强大
2013年04月05日 14点04分 16
level 8
非常不错!顶,大家想你学习!
2013年04月07日 05点04分 17
level 9

顶!!!![点头]
2013年04月07日 05点04分 18
level 5
[顶]
2013年04月07日 10点04分 19
level 11
mark 留待以后看
2013年04月08日 05点04分 20
1 2 尾页