正确的注释和注释风格
在程序的开头写一个总结,介绍每一个主要步骤并解释每个难以读懂之处。注释写得简明扼要是很重要的,不能让整个程序都充满注释而使程序很难读懂。
使用javadoc注释(/**……*/)
来注释整个类,或整个方法。为了将这些注释提取出来放在一个javadoc Html文件中,这些注释必须放在类或者方法头的前面。要注释方法中的某个步骤,使用行注释(//)。
正确的缩进和空白
保持一致的缩进风格会使程序更加清晰、易读、易于调试和维护。
在嵌套结构中,每个内层的组成部分或语句应该比外层缩进两格。二元操作符应该各加一个空格,例如:
System.out.println(3 + 4 * 4);
块的风格
块是由花括号围起来的一组语句。块的写法有两种常用方式:次行风格和行尾风格。
例如:
next-line:
public class Test
{
public static void main(String[] args)
{
System.out.println("Block Styles");
}
}
end-of-line:
public class Test{
public static void main(String[] args){
System.out.println("Block Styles");
}
}
次行风格将花括号垂直对齐,因而使程序容易阅读,而行尾风格更节省空间,并有助于避免犯一些细小的程序设计错误。
代码内应统一采用一种风格,建议不要将两种风格混合使用。
——《java语言程序设计基础篇》