一 前言

java編程規(guī)約是指在java代碼編寫過程中通俗的約定；通常我們是要遵守這些規(guī)范；這好比我們?cè)谏钪幸袷氐牡赖聹?zhǔn)則，如果你做的事情超出了道德的底線，那就有可能會(huì)受到社會(huì)抨擊；在java編程中也是類似的道理，如果你編寫的代碼不是很規(guī)范，盡管功能實(shí)現(xiàn)的功能強(qiáng)大，但其他java編程人員都看不懂你的代碼，別人就認(rèn)為你這是垃圾代碼，后期的維護(hù)工作就會(huì)很艱難，而且心里肯定對(duì)你很不爽；如果在工作中遇見這種情況，你l的eader就有可能讓你重寫編寫代碼；

二 命名規(guī)范

良好的代碼命名規(guī)則習(xí)慣有助于我們快速瀏覽代碼，讓代碼的可讀性強(qiáng)，易于他人閱讀，后期維護(hù)工作簡(jiǎn)單；

2.1 駝峰命名法

駝峰命名法（Camel-Case）是程序編程的通俗約定，其分為大駝峰寫法和小駝峰寫法；

大駝峰：每一個(gè)單詞首字母大寫，隨后的字母小寫；示例：ILoveJavaProgramer

小駝峰： 第一個(gè)單詞全小寫，之后的單詞首字母大寫，其余字母小寫；示例：iLoveJavaProgramer

2.2 包名寫法

比如我有個(gè)域名是： java.com; 我現(xiàn)在要?jiǎng)?chuàng)建工程的包結(jié)構(gòu)，那么通常包的命名規(guī)則是將域名反寫，之后跟具體的包名；所有的包名都統(tǒng)一使用小寫；

示例：com.java.zszxz.service

2.3 類名，接口名，文件名寫法

類名，接口名，文件名寫法統(tǒng)一采用大駝峰寫法；

示例：

類名：FileInputStream

接口名：InputStream

文件名：UserMapper.xml

2.4 方法名,字段名寫法

方法名 和 字段名稱 統(tǒng)一采用小駝峰命名寫法；

示例：

方法名：getUser()

字段名： fieldInfomation

2.4 常量名寫法

常量是特殊的字段，也就是特殊的變量，其約定的寫法跟之前稍有不同，其采用的寫法是所有單詞的字母都大寫，單詞之間使用下劃線隔開；

示例： I_LOVE_JAVA_PROGRAMER

三 代碼注釋

代碼的注釋的作用主要是進(jìn)行代碼解釋，類似你買了一個(gè)硬件設(shè)備，你要看說明書才知道怎么用這個(gè)設(shè)備，注釋就起到了說明書的功能；代碼注釋的第二個(gè)功能是能注釋到你當(dāng)前寫的代碼，但后面又可能用到該代碼，舍不得刪除的情況；

3.1 單行注釋

單行注釋源于c++,其意指能注釋掉一行代碼，使用兩個(gè)斜桿（//);

示例： // 我是知識(shí)追尋者，你是誰？覺得文章不錯(cuò)能幫助到你，那還不關(guān)注下？

3.2 多行注釋

多行注釋的風(fēng)格源于c；其是斜桿和星號(hào)開頭，中間部分是內(nèi)容，以星號(hào)和斜桿結(jié)束（/ ............... /）；

示例： / 今天你的小伙伴來找你了嗎? /

3.3 文檔注釋

文檔注釋是指能夠通過jdk的javadoc命令使注釋生成html幫助文檔，比如開發(fā)人員常看的jdk 的 API幫助文檔；使用格式是以斜桿和2個(gè)星號(hào)開頭，中間是內(nèi)容，以星號(hào)和斜桿結(jié)束（/* .................... /）；

通常文檔注釋只對(duì) public 和 protect 級(jí)別的的成員進(jìn)行注釋，內(nèi)部私有的成員是不提供給外部；

常用標(biāo)簽介紹：

了解更多標(biāo)簽示例請(qǐng)看：java文檔注釋

使用示例：

public class Doc {@Deprecatedprivate String buguaiguai;private String love;/*** @see java.lang.Object#toString()* @see java.lang.String* @see String* {@link System}* {@link System#getProperties()}* <a href="{@docRoot}/java/lang/doc-files/ValueBased.html">value-based</a>* @param love is favorite* @return the love* @deprecated <p>buguaiguai</p>* @throws RuntimeException contribution the java world* @since zszxz* @version 1.0.0* @author lsc/zszxz/youku1327*/public String getLove(String love){return "love";} }

生成doc命令

javadoc -d tagerPath sourcePath/className.java

命令過程：

C:Users林>javadoc -d C:mydatageneratordoc C:javaworkspaceforresourcestudy-01basesrcmainjavacomyouku1327basedocDoc.java 正在加載源文件C:javaworkspaceforresourcestudy-01basesrcmainjavacomyouku1327basedocDoc.java... 正在構(gòu)造 Javadoc 信息... 正在創(chuàng)建目標(biāo)目錄: "C:mydatageneratordoc" 標(biāo)準(zhǔn) Doclet 版本 1.8.0_131 正在構(gòu)建所有程序包和類的樹... 正在生成C:mydatageneratordoccomyouku1327basedocDoc.html... 正在生成C:mydatageneratordoccomyouku1327basedocpackage-frame.html... 正在生成C:mydatageneratordoccomyouku1327basedocpackage-summary.html... 正在生成C:mydatageneratordoccomyouku1327basedocpackage-tree.html... 正在生成C:mydatageneratordocconstant-values.html... 正在構(gòu)建所有程序包和類的索引... 正在生成C:mydatageneratordocoverview-tree.html... 正在生成C:mydatageneratordocindex-all.html... 正在生成C:mydatageneratordocdeprecated-list.html... 正在構(gòu)建所有類的索引... 正在生成C:mydatageneratordocallclasses-frame.html... 正在生成C:mydatageneratordocallclasses-noframe.html... 正在生成C:mydatageneratordocindex.html... 正在生成C:mydatageneratordochelp-doc.html...C:Users林>

生成結(jié)果：

四 空行與縮進(jìn)

4.1 空行

空行是指不同功能的代碼之間要做到空行，以便于區(qū)分；

通常類名接口名，與其成員保持2個(gè)空行，如果有注釋其也算一個(gè)空行；

不同類別的成員之間保持一個(gè)空行；

方法邏輯與方法名空一行；

示例：

/* * 類的注釋不需要空行 * / public class zszxz {// 成員與類或者接口包池2個(gè)空行，包括注釋；private String love;private Integer age; // 不同類別的成員保持一行private String gender;// 相同類名的成員不用空行public String getLove(){return "love"; // 方法邏輯與方法名空一行}}

4.2 縮進(jìn)

類和屬性；方法和邏輯；它們之間的縮進(jìn)都是以4個(gè)空格為單位，可以使用制表符來代替多個(gè)空格，作者的一個(gè)制表符設(shè)置的是2個(gè)空格；

示例：

/* * 類的開頭不需要空格 * / public class zszxz {// 成員與類或者接口保持4個(gè)空格private String love;private Integer age; // 成員與類或者接口保持4個(gè)空格private String gender;// 成員與類或者接口保持4個(gè)空格public String getLove(){ //成員與類或者接口保持4個(gè)空格return "love"; // 方法邏輯與方法名保持4個(gè)空格}}

總結(jié)

以上是生活随笔為你收集整理的html 注释_java基础- Java编程规范与注释的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。

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