代码样式
代码应该用 unix 的格式,而不是 windows 的(比如:回车变成回车+换行)
文档化
必须用 javadoc 来为类生成文档。不仅因为它是标准,这也是被各种 java 编译器都认可的方法。
缩进
缩进应该是每行4个空格. 不要在源文件中保存Tab字符. 在使用不同的源代码管理工具时Tab字符将因为用户设置的不同而扩展为不同的宽度.
如果你使用 UltraEdit 作为 Java 源代码编辑器的话,你可以通过如下操作来禁止保存Tab字符, 方法是通过 UltrEdit中先设定 Tab 使用的长度是4个空格,然后用 Format|Tabs to Spaces 菜单将 Tab 转换为空格。
页宽
页宽应该设置为80字符. 源代码一般不会超过这个宽度, 并导致无法完整显示, 但这一设置也可以灵活调整. 在任何情况下, 超长的语句应该在一个逗号或者一个操作符后折行. 一条语句折行后, 应该比原来的语句再缩进2个字符.
详细的操作方法或具体步骤
程序块
要有大括号,即使只有一句程序
{} 中的语句应该单独作为一行. 例如, 下面的第1行是错误的, 第2行是正确的:
如果 } 语句应该缩进到与其相对应的 { 那一行相对齐的位置。
![Java开发编码规范:[4]代码编写格式](http://www.52ij.com/uploads/allimg/160402/23302ab7-0.jpg)
括号
左括号和后一个字符之间不应该出现空格, 同样, 右括号和前一个字符之间也不应该出现空格. 下面的例子说明括号和空格的错误及正确使用:
CallProc(AParameter ); // 错误
CallProc(AParameter); // 正确
不要在语句中使用无意义的括号. 括号只应该为达到某种目的而出现在源代码中。下面的例子说明错误和正确的用法:
if ((I)=42) { // 错误 - 括号毫无意义
if (I==42) or (J==42) then // 正确 - 的确需要括号
import
对于import语句,如果某一个包中引用的类不超过三个(包括三个),不允许用import xxx.*;格式。
变量
定义及方法的返回值不允许使用全包名,如java.lang.String,除非在不同的包中有相同名字的类,必须用全名来区分。对于类中属性的存取要用方法(getXXX/setXXX,boolean值用isXXX/setXXX),不要直接引用。
Java开发编码规范(共8篇)上一篇:Java 文件样式|下一篇:权限修饰经验内容仅供参考,如果您需解决具体问题(尤其法律、医学等领域),建议您详细咨询相关领域专业人士。作者声明:本教程系本人依照真实经历原创,未经许可,谢绝转载。- 评论列表(网友评论仅供网友表达个人看法,并不表明本站同意其观点或证实其描述)
-
