小編給大家分享一下javadoc規(guī)范是什么，相信大部分人都還不怎么了解，因此分享這篇文章給大家參考一下，希望大家閱讀完這篇文章后大有收獲，下面讓我們一起去了解一下吧！

濟(jì)南網(wǎng)站制作公司哪家好，找成都創(chuàng)新互聯(lián)公司！從網(wǎng)頁(yè)設(shè)計(jì)、網(wǎng)站建設(shè)、微信開(kāi)發(fā)、APP開(kāi)發(fā)、響應(yīng)式網(wǎng)站建設(shè)等網(wǎng)站項(xiàng)目制作，到程序開(kāi)發(fā)，運(yùn)營(yíng)維護(hù)。成都創(chuàng)新互聯(lián)公司從2013年成立到現(xiàn)在10年的時(shí)間，我們擁有了豐富的建站經(jīng)驗(yàn)和運(yùn)維經(jīng)驗(yàn)，來(lái)保證我們的工作的順利進(jìn)行。專注于網(wǎng)站建設(shè)就選成都創(chuàng)新互聯(lián)公司。

導(dǎo)語(yǔ)：

我們知道javadoc是內(nèi)嵌于JDK中的，因此遵循javadoc規(guī)范肯定就是java注釋的正統(tǒng)，有了javadoc幫助生成API文檔是非常實(shí)用的。

1、什么是注釋

注釋是為了使代碼更具有可讀性，降低團(tuán)隊(duì)合作的交流成本。在一個(gè)團(tuán)隊(duì)中，你的代碼更清晰、更易讀，更規(guī)范，那么升職加薪肯定是你的，因?yàn)槟憧梢约嫒莞嗟娜恕?br/>前段時(shí)間聽(tīng)到一個(gè)說(shuō)法：你的代碼寫(xiě)的只有你一個(gè)人看得懂，那你就是那個(gè)不可或缺的人。說(shuō)這話的人就是腦殘，寫(xiě)的代碼只有自己看的懂得話，大家都不待見(jiàn)，活的像孫子一樣，難道大家都需要孫子嗎？

2、常用注釋快捷鍵

注釋一行：//我是行內(nèi)容
快捷鍵：ctrl+/ 反操作：ctrl+/注釋一塊：/*我是塊內(nèi)容*/
快捷鍵：ctrl+shift+/ 反操作：ctrl+shift+\javadoc可識(shí)別的注釋：

	/**
	 * 我是注釋
	 * 我也是注釋
	 * 我還是注釋，我們都能被javadoc識(shí)別
	 */

3、javadoc規(guī)范

遵循javadoc規(guī)范，我們就可以使用javadoc命令，生成非常直觀易讀的API文檔，非常方便。
我們?cè)诔绦蛑谐霈F(xiàn)的注釋可以有意識(shí)地分為兩種，一種是簡(jiǎn)易的注釋，給我們自己看的，一種是符合javadoc規(guī)范的注釋，目的是生成易讀的文檔。
仔細(xì)閱讀生成的API文檔，有三部分需要我們說(shuō)明，如圖：

上面紅框的內(nèi)容都是我添加的注釋，是一個(gè)簡(jiǎn)單的Hello類，源碼如下，感興趣可以自己去試試：

/**
  *	@author XXXX
  *	@version 創(chuàng)建時(shí)間：2021年1月21日 下午3:22:01
  *	
  */
public class Hello {

	/**
	 * main()方法簡(jiǎn)述(后面這個(gè)dot必不可少).
	 * 
這就是為了測(cè)試注釋

	 * 沒(méi)什么好說(shuō)明的，只為了說(shuō)明能出現(xiàn)在這里
	 * @param args 就是系統(tǒng)配的，沒(méi)啥說(shuō)的
	 * 
	 */
	public static void main(String[] args) {
//		 TODO Auto-generated method stub
		System.out.println("hello");	

	}
	
	/**
	 * havaReturn方法就是為了測(cè)試javadoc注釋規(guī)范的.
	 * 
我發(fā)現(xiàn)只有有返回值的方法才可以使用return標(biāo)簽

	 * 沒(méi)有return硬是要用，只會(huì)在javadoc時(shí)候報(bào)錯(cuò)
	 * @param a 輸入的第一個(gè)int類型的參數(shù)
	 * @param b 輸入的第二個(gè)int類型的參數(shù)
	 * @return add 兩個(gè)數(shù)的和運(yùn)算結(jié)果
	 */
	public int haveReturn(int a,int b){
		int add=0;
		add=a+b;
		return add;
	}

}

有幾個(gè)要點(diǎn)需要指出：

要想API文檔出現(xiàn)作者和版本，不僅要在程序注釋中添加@author和@version（需要說(shuō)明的是，在程序多個(gè)地方注釋@author也只會(huì)在最終文檔中顯示一次，我建議只注釋一次），還要在編譯的時(shí)候在dos命令中指出：
javadoc -d folder -version -author Hello.java
其中-d folder意思是你把生成的API文檔（其實(shí)是很多網(wǎng)頁(yè)組成的）放在folder文件夾中，當(dāng)然folder也可以是個(gè)路徑

方法概要 與 方法詳細(xì)資料 怎么區(qū)分呢？

/**
	 * main()方法簡(jiǎn)述(后面這個(gè)dot必不可少).
	 * 
這就是為了測(cè)試注釋

	 * 沒(méi)什么好說(shuō)明的，只為了說(shuō)明能出現(xiàn)在這里
	 * @param args 就是系統(tǒng)配的，沒(méi)啥說(shuō)的
	 * 
	 */
	public static void main(String[] args) {
//		 TODO Auto-generated method stub
		System.out.println("hello");	

	}

你一定發(fā)現(xiàn)關(guān)于方法的注釋都是一大坨，javadoc如何提取概要呢？沒(méi)錯(cuò)，就只靠一個(gè)dot(.)，觀察我注釋里面提到的那個(gè)dot，那就是提取概要的關(guān)鍵，dot之前是概要，所有的都是詳細(xì)介紹（詳細(xì)介紹是包含概要的）

如何控制生成的文檔中的注釋排版
我們?cè)诔绦蛑心芸刂谱〉木褪亲⑨尩呐虐?，但是這種排版并不被javadoc識(shí)別，javadoc發(fā)現(xiàn)一行注釋，只去掉*和空格之后，就一股腦傳過(guò)去，注意到生成的文檔是HTML類型的，所以只要在程序中注釋HTML語(yǔ)法，就能實(shí)現(xiàn)編輯API文檔格式，不要擔(dān)心太困難，因?yàn)槲覀冎皇怯靡恍┖?jiǎn)單的HTML語(yǔ)法，比如段落

，換行
這些就可以，畢竟注釋也不會(huì)很長(zhǎng)。

@param 參數(shù)1 說(shuō)明 （注意格式）

@return 返回值 說(shuō)明（注意格式）
有返回值就寫(xiě)，沒(méi)返回值就不用寫(xiě)，寫(xiě)了反而會(huì)報(bào)錯(cuò)

其實(shí)寫(xiě)類注釋、方法注釋非常簡(jiǎn)單，只要在類、方法前敲擊/**，再按回車，系統(tǒng)就會(huì)自動(dòng)添加，并且系統(tǒng)如何添加也是我們可以修改的

如何修改新建文件時(shí)出現(xiàn)的內(nèi)容，如何使自動(dòng)補(bǔ)全的注釋受我們控制（待辦）

我們從標(biāo)準(zhǔn)類文件中看到這個(gè)：

我們都知道，out是System類的屬性（字段），它是PrintStream類型的，類PrintStream中定義了很多方法，這些自然也是out的方法，因此在定義out的時(shí)候，它前面的注釋中就有很多@see,這就是使用@see注釋最好的地方，我們推薦在定義類的字段時(shí)，如果字段是復(fù)合類型的（特別是自定義的復(fù)合類型），那么就在前面注釋@see,這樣有兩方面的好處，請(qǐng)看圖：

相信這兩張圖你都不陌生，第一個(gè)是寫(xiě)程序時(shí)候光標(biāo)停留可以出現(xiàn)的提示，如果你按照javadoc規(guī)范來(lái)寫(xiě)注釋，那么你自己寫(xiě)的程序也會(huì)出現(xiàn)這些極有幫助的提示。第二個(gè)是java8 API文檔關(guān)于String類里的out字段的詳細(xì)描述，這也是@see的功勞，你寫(xiě)了@see，你自己的項(xiàng)目API文檔中也有這樣的注釋。

以上是“javadoc規(guī)范是什么”這篇文章的所有內(nèi)容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內(nèi)容對(duì)大家有所幫助，如果還想學(xué)習(xí)更多知識(shí)，歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道！