Java编码约定

来源:互联网 发布:python学习手册 pdf 编辑:程序博客网 时间:2024/05/16 11:13

虽然任何一个合法的标识符都可以用来当作变量、类、方法等的名称,但是Java编程语言极力推荐它的编码约定:

n classes──类名应该是名词,大小写可混用,但首字母应大写。

例如:

class  AccountBook

class  ComplexVariable

n interface──界面(接口)名大小写规则与类名相同。

interface  Account

n method──方法名应该是动词,大小写可混用,但首字母应小写。在每个方法名内,大写字母将词分隔并限制使用下划线。例如:

balanceAccount()

addComplex ()

n Variables──所有变量都可大小写混用,但首字符应小写。词由大写字母分隔,限制用下划线,限制使用美元符号($),因为这个字符对内部类有特殊的含义。

currentCustomer

变量应该代表一定的含义,通过它可传达给读者使用它的意图。尽量避免使用单个字符, 除非是临时“即用即扔”的变量(例如,用i, j, k作为循环控制变量)

n constant──原始常量应该全部大写并用下划线将词分隔;对象常量可大小写混用。

HEAD_COUNT

MAXIMUM_SIZE

n control structures──当语句是控制结构的一部分时,即使是单个语句也应使用括号({})将语句封闭。例如:

if  (condition) {

   do something

}else  {

   do something else

n spacing──每行只写一个语句并使用 tab键缩格使你的代码更易读。

n comments──用注释来说明那些不明显的代码段落;对一般注释使用 //  分隔符, 而大段的代码可使用 /*···*/分隔符。使用 /**···*/将注释形成文档,并输入给javadoc以生成HTML代码文档。

// A comment that takes up only one line.

/* Comments that continue past one line and take up space on multiple lines... */

/**

 * A comment for documentation purposes.

 * 

 * @see Another class for more information

 */


原创粉丝点击