java高效编码的四项约定

靖凯开源


事件发生在(2018-09-19)上午10点20分左右,美国硅谷 WTS Paradigm公司43岁的ERP程序猿安东尼·汤(Anthony Tong)出现在办公室,拿出一把事先准备好的半自动手枪向周围 4 名同事开火。其他工作人员见状纷纷逃离办公楼,跑到附近的公司避难。警察在短短几分钟内赶到现场,这名行凶者准备还向警察开火。见状四名警察随后同时开火,击中了嫌犯,嫌犯随后被送到附近的一家医院后就被宣布死亡。

事后,一位女程序媛透露,当时自己正伏案工作,突然听到枪响,就赶紧跑出大楼,躲在一辆汽车后面。她说,办公楼的玻璃大门都被打碎了。被采访的其他同事表示“完全出人意料。我们都是搞软件的!我们是很好的团队!大家都很友好!”

在随后的第二天,警方召开了记者发布会,在会上警方表示该行凶者没有犯罪记录,枪击事件发生时独自作案。目前,没有任何迹象表明到底是什么原因引发了这起流血事件;警方已呼吁目击者与警方取得联系。这件事目前在国外引起了广泛的讨论,据悉,相关人士猜测说最有可能是:

     同事不写注释,

     不遵循驼峰命名,

      括号换行,

      最主要还天天 git push -f      

等等因素...

最后激怒了这名程序猿

吓死我了,赶紧找出当年靖凯开源的老师讲的“高效编码的四项约定温习一把

高效编码的四项约定

1. Java 命名约定   

除了以下几个特例之外,命名时应始终采用完整的英文描述符。此外,一般应采用小写字母,但类名、接口名以及任何非初始单词的第一个字母要大写。 


1.1 一般概念   

* 尽量使用完整的英文描述符   

* 采用适用于相关领域的术语   

* 采用大小写混合使名字可读   

* 尽量少用缩写,但如果用了,要明智地使用,且在整个工程中统一   

* 避免使用长的名字(小于 15 个字母是个好主意)    

* 避免使用类似的名字,或者仅仅是大小写不同的名字   

* 避免使用下划线(除静态常量等) 


1.2 示范   

* 包(Package) 采用完整的英文描述符,应该都是由小写字母组成。对于全局包,将你的 Internet 域名反转并接上包名。 如:       

java.awt      com.ambysoft.www.persistence   


* 类(Class) 采用完整的英文描述符,所有单词的第一个字母大写。 如:       

Customer      SavingsAccount   


* 接口(Interface) 采用完整的英文描述符说明接口封装,所有单词的第一个字母大写。习惯上,名字后面加上后缀 able, ible 或者 er,但这不是必需的。如:       Contactable      Prompter   


* 组件/部件(Component) 使用完整的英文描述来说明组件的用途,末端应接上组件类型。 

如:       okButton       customerList       fileMenu   


* 异常(Exception)通常采用字母 e 表示异常。 e   


* 类变量 字段采用完整的英文描述,第一个字母小写,任何中间单词的首字大写,

如: firstName       lastName   


* 实参/参数 同字段/属性的命名规则       

public void setFirstName(String firstName){             

   this.firstName = firstName;      

}   


* 局部变量 同字段/属性的命名规则    

  ** 获取成员函数 被访问字段名的前面加上前缀 get。 getFirstName(), getLastName()    

  ** 布尔型的获取成员函数 所有的布尔型获取函数必须用单词 is 做前缀。 isPersistent(), isString()     

  ** 设置成员函数 被访问字段名的前面加上前缀 set。 setFirstName(), setLastName(),setWarpSpeed()     

  ** 普通成员函数 采用完整的英文描述说明成员函数功能,第一个单词尽可能采用一个生动的动词,第一个字母小写。 openFile(), addAccount()     


* 静态常量字段(static final) 全部采用大写字母,单词之间用下划线分隔。 MIN_BALANCE, DEFAULT_DATE          


* 循环计数器 通常采用字母 i,j,k 或者 counter 都可以接受。 i, j, k, counter     


* 数组 数组应该总是用下面的方式来命名: byte[] buffer;


2. Java 注释约定   一个很好的可遵循的有关注释的经验法则是:问问你自己,你如果从未见过这段代码,要在合理的时间内有效地明白这段代码,你需要哪些信息。   


1.1 一般概念 

  * 注释应该增加代码的清晰度   

  * 保持注释的简洁   

  * 在写代码之前写注释   

  * 注释出为什么做了一些事,而不仅仅是做了什么     


2.1. 示范   

* 文档注释       在紧靠接口、类、成员函数和字段声明的前面注释它们。      

/**     

     *     * 客户:客户是我们将服务和产品卖给的人或机构。  **/   


* C 语言风格   采用 C 语言风格的注释去掉不再使用但你仍想保留的代码。仍想保留是因为用户万一会改变想法,或者在调试过程中想让它暂时失效。如:     

/* 这部分代码因为已被它之前的代码取代,由 B.Gustafsson, 于 2018 年 6 月     

*4 日注释掉。如果两年之后还未使用,将其删除。. . .     *(源代码)     */   


* 单行       在成员函数内采用单行注释,来说明业务逻辑、代码段和暂时变量的声明。注释符"//"后必须紧跟一个空格,然后才是注释信息。 如:      

  // 遵照 Sarek 的规定,给所有      

  // 超过 $1000 的发货单      

  // 打 5% 的折扣。让利活      

  // 动于 2015年 2 月开始.    


2.2. 注释哪些部分   

类   类的目的、即类所完成的功能,注释出采用的变量。   

接口 设置接口的目的、它应如何被使用以及如何不被使用。   

成员函数注释 对于设置与获取成员函数,在成员变量已有说明的情况下,可以不加注释;普通成员函数要求说明完成什么功能,参数含义是什么返回什么;   

普通成员函数内部注释 控制结构,代码做了些什么以及为什么这样做,处理顺序等。   

实参/参数   参数含义、及其它任何约束或前提条件   

字段/属性   字段描述    

局部变量    无特别意义的情况下不加注释 


3. Java 文件样式约定   所有的 Java(*.java) 文件都必须遵守如下的样式规则:   


1) 版权信息   版权信息必须在 java 文件的开头,比如:   /**     * Copyright @ 2000 Shanghai XXX Co. Ltd.     * All right reserved.     * @author: gcgmh     * date: 2008-12-22     */   

其他不需要出现在 javadoc 的信息也可以包含在这里。 


2) Package/Imports   package 行要在 import 行之前,import 中标准的包名要在本地的包名之前,而且按照字母顺序排列。如果 import 行中包含了同一个包中的不同子目录,则应该用 * 来处理。   

package hotlava.net.stats;           

import java.io.*;     

import java.util.Observable;      

import hotlava.util.Application;   这里 java.io.* 是用来代替InputStream and OutputStream 的。   


3) Class   接下来的是类的注释,一般是用来解释类的。 /**    * A class representing a set of packet and byte counters    

    * It is observable to allow it to be watched, but only      * reports changes when the current set is complete    */   

接下来是类定义,包含了在不同的行的 extends 和 implements  

public class CounterSet extends 

       Observable implements Cloneable{    

         ……         

         ……     }        


4) Class Fields   接下来是类的成员变量:   

/**     * Packet counters     */    

 protected int[] packets;   

public的成员变量必须生成文档(JavaDoc)。

proceted、private和 package 定义的成员变量如果名字含义明确的话,可以没有注释。 


5) 存取方法(类的设置与获取成员函数)   接下来是类变量的存取的方法。它只是简单的用来将类的变量赋值获取值的话,可以简单的写在一行上,如类的成员变量已经有注释,类变量的存取方法可以没有注释。   

public int[] getPackets() { return this.packets; }    public void setPackets(int[] packets) {

   this.packets = packets;

 }      ……   

要求说明的是,对于集合,加入成员函数来插入和删除项;另其它的方法不要写在一行上。   


6) 构造函数   接下来是构造函数,它应该用递增的方式写(比如:参数多的写在后面)。   

public CounterSet(int size){ this.size = size;}   


7) 克隆方法   如果这个类是可以被克隆的,那么下一步就是 clone 方法:   

public Object clone() {

 try { 

   ……

   }catch(CloneNotSupportedException e) {

 …… 

   }

}   


8) 类方法 (类的普通成员函数)   下面开始写类的方法:    

/**    * Set the packet counters    

* param r1 - ……    

* param r2 - ……    

* ……    */   

protected final void setArray(int[] r1, int[] r2, 

   int[] r3, int[] r4) throws

      IllegalArgumentException{   

 // Ensure the arrays are of equal size   

 ……   } 


9) toString 方法   一般情况下,每一个类都应该定义 toString 方法:   

      public String toString() { ……}   


10) main 方法   普通类,考虑置入一个main()方法,其中包含用于测试那个类的代码,如果包含了main() 方法, 那么它应该写在类的底部。   


4. Java编码其它约定   

文档化   必须用 javadoc 来为类生成文档。不仅因为它是标准,这也是被各种 java 编译器都认可的方法。使用 @author 标记是不被推荐的,因为代码不应该是被个人拥有的。  


缩进   

缩进应该是每行2个空格。 不要在源文件中保存Tab字符, 在使用不同的源代码管理工具时Tab字符将因为用户设置的不同而扩展为不同的宽度。   如果你使用 UltrEdit 作为你的 Java 源代码编辑器的话,你可以通过如下操作来禁止保存Tab字符, 方法是通过 UltrEdit中先设定 Tab 使用的长度室2个空格,然后用 Format|Tabs to Spaces 菜单将 Tab 转换为空格。   


页宽   

页宽应该设置为80字符。 源代码一般不会超过这个宽度, 并导致无法完整显示, 但这一设置也可以灵活调整。 在任何情况下, 超长的语句应该在一个逗号或者一个操作符后折行。 一条语句折行后, 应该比原来的语句再缩进2个字符。   n {} 对   {} 中的语句应该单独作为一行。 例如, 下面的第1行是错误的, 第2行是正确的:   if (i>0) { i ++ }; // 错误, { 和 } 在同一行 if (i>0) { i ++ }; // 正确, 单独作为一行   


括号   

左括号和后一个字符之间不应该出现空格; 同样, 右括号和前一个字符之间也不应该出现空格。 下面的例子说明括号和空格的错误及正确使用: CallProc(AParameter); // 正确   不要在语句中使用无意义的括号,括号只应该为达到某种目的而出现在源代码中。   


JSP文件命名   

采用完整的英文描述说明JSP所完成的功能,尽可能包括一个生动的动词,第一个字母小写,如:viewMessage.jsp、editUser.jsp或者forumChooser.jsp等。   


Servlet类命名   

一般对应于所服务的对象加后缀Service来命名,如:UserService,TradeService等。   


明星学员

李兴忠 就职于环京科技

转正5000

李律明 就职于数字方舟

转正8000

李泽腾 就职于云锐网络科技

12000

欧宜 就职于广州市健坤网络科技发展有限公司

转正5000

李洪奋 就职于广东星城科技有限公司

转正5500

刘哲 就职于暢译科技

转正7000