前言

筆者最近幫助一些朋友應(yīng)聘遠(yuǎn)程工作(一般都是一些國(guó)外的項(xiàng)目)，國(guó)外的項(xiàng)目負(fù)責(zé)人一般都會(huì)要求提供github賬號(hào)或者一些源代碼，很多朋友在這一關(guān)就被篩選掉了，其中不乏一些我認(rèn)為技術(shù)非常厲害的行業(yè)大牛，他們都研發(fā)過(guò)很多的大型項(xiàng)目，經(jīng)驗(yàn)與技術(shù)實(shí)力都非常不錯(cuò)。那究竟是為什么呢？我經(jīng)過(guò)仔細(xì)的研究，發(fā)現(xiàn)他們都有一個(gè)共同點(diǎn)，就是命名規(guī)范不太嚴(yán)謹(jǐn)。我對(duì)這些在應(yīng)聘遠(yuǎn)程項(xiàng)目第一關(guān)就被篩選掉了的程序員做了一個(gè)問(wèn)卷調(diào)查：你都知道哪些java命名規(guī)范？最終結(jié)果顯示：

• 類(lèi)的首字母要大寫(xiě)，使用駝峰標(biāo)識(shí)
• 變量首字母小寫(xiě)，使用駝峰標(biāo)識(shí)
• 常量字母全部大寫(xiě)，下劃線(xiàn)分隔
• 使用英文單詞，不要使用拼音

在很多的java程序員看來(lái)能做到這些，就已經(jīng)是很規(guī)范的命名方式了，究竟還有哪些不足之處？筆者總結(jié)了一下java開(kāi)發(fā)中的最常用的一些命名規(guī)范，如果有不足之處，還請(qǐng)各位朋友不吝賜教！如果您覺(jué)得本文對(duì)您有幫助，期待您能幫忙關(guān)注、轉(zhuǎn)發(fā)！

一、package命名規(guī)范

軟件項(xiàng)目的包名稱(chēng)應(yīng)該是由您的公司的域名的倒序，再加上您的項(xiàng)目的名稱(chēng)，均使用小寫(xiě)字母，不能包含其他符號(hào)?？梢栽谧詈筇砑影陌姹?，如下圖實(shí)例所示：

org.example.aprojectname
org.example.aprojectname.innerpkg
org.example.aprojectname.innerpkg.anotherpkg
org.example.aprojectname.innerpkg2
org.example.anotherproject
org.example.anotherproject.v2

二、Class命名規(guī)范

類(lèi)名必須是一個(gè) 名詞，使用駝峰命名方式，首字母應(yīng)大寫(xiě)，例如HashMap。應(yīng)該可以從類(lèi)名中推斷出它大概會(huì)包含什么樣的函數(shù)和變量。例如：

class Student{}
class ArrayList{}
class HashMap{}
class ComputerEngineer{}

三、Interface接口

接口名稱(chēng)應(yīng)盡量使用 形容詞。有時(shí)也可以是名詞，如：List或Map。與類(lèi)的命名規(guī)范一樣，使用駝峰命名，首字母應(yīng)大寫(xiě)。如下：

interface Cloneable{}
interface AutoCloseable{}
interface PreparedStatement{}
interface Engineer{}

接口通常代表一類(lèi)對(duì)象的總稱(chēng)。形容詞“會(huì)跑的”可以是一個(gè)接口名稱(chēng)，實(shí)現(xiàn)類(lèi)可以是人、狗、貓。

而使用名詞需要具有一定的概括性，“爪子”比“貓爪”更像是一個(gè)接口的名字。

四、變量

變量盡量是簡(jiǎn)短而且有意義的名詞，遵循駝峰命名，首字母小寫(xiě)。并且不要使用劃線(xiàn)（'_'）或美元符號(hào)'$'字符。

• 在for循環(huán)中使用的計(jì)數(shù)變量，可以是i，j，k，m和n，它們也常用于整數(shù)
• 對(duì)于 布爾值，通常開(kāi)頭應(yīng)該是is或has。
• 可以使用Of串聯(lián)多個(gè)名詞
• 可以使用形容詞修飾名詞

int countOfCustomer;   //Of串聯(lián)
float averageInterest;   //形容詞修飾名詞
long timeInMillisecond, daysInYear;    //時(shí)間
boolean isEngineer, isCompleted, hasSubmitted;   //布爾類(lèi)型

五、常量

常量也是程序的重要組成部分。也要使用名詞，或者形容詞修飾的名詞。全部字母大寫(xiě)，使用下劃線(xiàn)分隔單詞。

public static final float PI = 3.14;
static int CREATED_ON_YEAR = 2019;

六、方法

方法名稱(chēng)要使用動(dòng)詞，并且應(yīng)該從名稱(chēng)中可以推斷出方法的功能，盡量簡(jiǎn)短。使用駝峰標(biāo)志命名。通常， get 和 set 用于分別獲取數(shù)據(jù)和設(shè)置數(shù)據(jù)。對(duì)于布爾值，方法名稱(chēng)應(yīng)與與變量名稱(chēng)相同。

void print(Object obj);
void remove(Obejct obj);
Object update();
int getCountOfCustomer();//getter
void setCountOfCustomer(int countOfCustomers);//setter
boolean isUserAdmin(User user);  //布爾類(lèi)型

七、泛型

使用單個(gè)大寫(xiě)字母， T使用的比較廣泛。E通常被用于集合元素，K和V通常被用于映射關(guān)系。請(qǐng)勿使用多字符。

public <T> void print(T t);
interface List<E>{}
class HashMap<K, V> {};

以上就是java開(kāi)發(fā)國(guó)際化項(xiàng)目需遵循的命名規(guī)范的詳細(xì)內(nèi)容，更多關(guān)于java國(guó)際化命名規(guī)范的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

最新評(píng)論