java程序的编码规范(4)
作者:李小敏 本文选自:ibm dw中国 2002年08月21日
● main 方法
如果main(string[]) 方法已经定义了,那么它应该写在类的底部。
代码编写格式
● 代码样式
代码应该用 unix 的格式,而不是 windows 的(比如:回车变成回车+换行) 。
● 文档化
必须用 javadoc 来为类生成文档。不仅因为它是标准,这也是被各种 java 编译器都认可的方法。使用 @author 标记是不被推荐的,因为代码不应该是被个人拥有的。
● 缩进
缩进应该是每行2个空格。不要在源文件中保存tab字符。在使用不同的源代码管理工具时tab字符将因为用户设置的不同而扩展为不同的宽度。
如果你使用 ultredit 作为你的 java 源代码编辑器的话,你可以通过如下操作来禁止保存tab字符,方法是通过 ultredit中先设定 tab 使用的长度室2个空格,然后用 formattabs to spaces 菜单将 tab 转换为空格。
● 页宽
页宽应该设置为80字符。源代码一般不会超过这个宽度,并导致无法完整显示,但这一设置也可以灵活调整。在任何情况下,超长的语句应该在一个逗号或者一个操作符后折行。一条语句折行后,应该比原来的语句再缩进2个字符。
● {} 对
{} 中的语句应该单独作为一行。例如,下面的第1行是错误的第2行是正确的:
if (i>0) { i ++ }; // 错误, { 和 } 在同一行
if (i>0) {
i ++
}; // 正确, { 单独作为一行
} 语句永远单独作为一行。
如果 } 语句应该缩进到与其相对应的 { 那一行相对齐的位置。
● 括号
左括号和后一个字符之间不应该出现空格,同样,右括号和前一个字符之间也不应该出现空格。下面的例子说明括号和空格的错误及正确使用:
callproc( aparameter ); // 错误
callproc(aparameter); // 正确
不要在语句中使用无意义的括号。括号只应该为达到某种目的而出现在源代码中。下面的例子说明错误和正确的用法:
if ((i) = 42) { // 错误 - 括号毫无意义
if (i == 42) or (j == 42) then // 正确 - 的确需要括号
Java Asp PHP .Net XML C/C++ CGI VB Jsp J2ee J2se J2me EJB Servlet Tomcat Resin Struts Weblogic Eclipse ANT GUI JMS Web servise IDEA Webphere Hibernate Spring Jboss Applet Swing Socket Javamail Perl Ajax P2P 安全 模式 框架 测试 开源 游戏
Windows XP Windows 2000 Windows 2003 Windows Me Windows 9.x Linux UNIX 注册表 操作系统 服务器 应用服务器