Java编程风格及规范
1.适当的注释和注释风格
- 在程序的开头写一段摘要,来说明程序的目的和主要特点,解释所用的重要数据结构和独特技术。
- 在程序中,每个主要步骤加上注释,来解释下难懂之处。
- 注释要写的简明,不能挤满程序而降低程序的可读性。
- (/**…*/)注释整个类或者整个方法。
- (//) 方法内的步骤注释。
2.命名习惯
- 变量和方法,使用小写。如果名字包括几个词,把他们连成一个,第一个词的字母小写,而后面的每一个词的首字母大写,例如:showTime。
- 类名每个单词的首字母大写,例如:Computer、ComputeArea.
常量中的所有字母都大写,两个单词之间用下划线连接,例如:常量PI和常量MAX_VALUE. - 对类命名时,不要选择已经在Java库中使用了的名称。比如:Java已定义了Math类,就不应该使用Math命名你的类了。
- 对标识符应避免使用缩写,使用完整的单词更具有描述性。例如:numberOfStudents比numStuds或numOfStuds好。
3.适当的缩进和空白
- 在嵌套结构中,每个内层的组件或者语句应该比外层缩进两格。 应该在二元运算符两边各加一个空格,如:int i = 5 + 8;
4.块的对齐方式
- 次行风格(next-line),将括弧垂直对齐。
- 行尾风格(end-line)