前言

? ? 一個(gè)軟件生命周期中，從可行性研究分析、計(jì)劃到需求分析，再到軟件設(shè)計(jì)、編碼實(shí)現(xiàn)、測(cè)試，最后交付使用，運(yùn)行維護(hù)過(guò)程中，維護(hù)過(guò)程占據(jù)了很大的比例，一個(gè)軟件的生命周期中，很難保證自始至終都由最初的開(kāi)發(fā)人員來(lái)維護(hù)。作為一個(gè)開(kāi)發(fā)人員，他可能會(huì)把自己手頭上的工作轉(zhuǎn)交給其他人，也可能會(huì)從其他開(kāi)發(fā)人員手中接手其他任務(wù)。面對(duì)一個(gè)龐大的系統(tǒng)，開(kāi)發(fā)人員怎么才能快速、高效的做好交接工作，讓別人讀懂自己的代碼，自己又能看懂他人的代碼，給他人和自己帶來(lái)方便呢？這就需要開(kāi)發(fā)人員在編碼過(guò)程中都遵守一些約定俗成的規(guī)范，這樣既能方便自己也能方便他人。
? ? 編程規(guī)范是對(duì)編程的一種約定，主要的作用就是增強(qiáng)代碼的規(guī)范性，提高我們編寫代碼的質(zhì)量，為后續(xù)再返回看自己的之前的代碼，或者給他人看我們自己的代碼提供一種便利，易于理解、方便閱讀，增加代碼的可維護(hù)性。

正文

命名總體原則：

1.從業(yè)務(wù)出發(fā)，名字能表示事物的特性;
2. 使用英文單詞，不能為拼音/漢字；
3. 名字長(zhǎng)度不應(yīng)多于4個(gè)單詞，控制在3-30個(gè)字母以內(nèi)；
4. 采用駝峰命名法；
5. 命名避免與關(guān)鍵字沖突；

? 1、方法命名：
增加/插入方法用add作為前綴；
刪除方法用delete作為前綴；
更改/更新方法用update作為前綴；
查詢/獲取單個(gè)對(duì)象方法用find作為前綴；
查詢/獲取多個(gè)對(duì)象方法用query作為前綴。
? 2、屬性
以名詞或形容詞命名；
使用Pascal大小寫；
禁止縮寫；
Javabean屬性命名使用常用的駝峰命名規(guī)則；
屬性名第一個(gè)單詞避免使用一個(gè)字母：eMail；
boolean屬性名避免使用“is”開(kāi)頭的名稱,因?yàn)檫@和JavaBean規(guī)范中bool類型取值操作命名沖突，取值規(guī)范是isXXX；
在類屬性中不需要包含類名。
? 3、常量const
禁止縮寫；
采用完整的英文大寫單詞，詞之間用下劃線連接；
命名簡(jiǎn)短，<16個(gè)字符；
同一組的常量可以用常量類封裝在一起，方便引用和維護(hù)；
代碼中用到常量的，使用靜態(tài)常量表示。
? 4、變量和字段
private、protected 使用 Camel 大小寫；
禁止使用public；
字段命名規(guī)范，使用駝峰命名；
對(duì)于主鍵字段， id命名:如：studentId，需要加上與實(shí)體類相關(guān)的名稱;
對(duì)于時(shí)間類型的字段，采用dateTime, 格式：YYYY-MM-dd HH:mm:ss;
布爾變量名應(yīng)該包含 Is，這意味著 Yes/No 或 True/False 值，如 fileIsFoundl;
DataSet類型的變量以ds開(kāi)頭，DataTable類型的變量以table開(kāi)頭;
在變量名中使用互補(bǔ)對(duì)，如 min/max、begin/end 和 open/close;
即使對(duì)于可能僅出現(xiàn)在幾個(gè)代碼行中的生存期很短的變量，仍然使用有意義的名稱。僅對(duì)于短循環(huán)索引使用單字母變量名，如 i 或 j;
對(duì)不易清楚識(shí)別出該變量類型的變量應(yīng)使用類型縮寫作其前綴，如字符串使用strXXX,boolean使用isXXX;
命名簡(jiǎn)短，<16個(gè)字符；
靜態(tài)字段：使用名詞、名詞短語(yǔ)或者名詞的縮寫命名靜態(tài)字段；Pascal命名法。

總結(jié)

以上是生活随笔為你收集整理的Java开发代码规范之编程规约---命名风格的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。