国产av日韩一区二区三区精品,成人性爱视频在线观看,国产,欧美,日韩,一区,www.成色av久久成人,2222eeee成人天堂

javadoc規(guī)范介紹

王林
發(fā)布: 2021-01-25 09:49:39
轉(zhuǎn)載
3085人瀏覽過(guò)

javadoc規(guī)范介紹

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

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

(學(xué)習(xí)視頻分享:java視頻教程

1、什么是注釋

立即學(xué)習(xí)Java免費(fèi)學(xué)習(xí)筆記(深入)”;

注釋是為了使代碼更具有可讀性,降低團(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í)別的注釋?zhuān)?/p>

	/**
	 * 我是注釋
	 * 我也是注釋
	 * 我還是注釋?zhuān)覀兌寄鼙籮avadoc識(shí)別
	 */
登錄后復(fù)制

3、javadoc規(guī)范

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

475d9258f5abca85af97cac4ea3790b.png

d187adbe1a4585398e4cb8221b554bf.png

cd877cd7644d533e48c0cdaefb2a8bb.png

上面紅框的內(nèi)容都是我添加的注釋?zhuān)且粋€(gè)簡(jiǎn)單的Hello類(lèi),源碼如下,感興趣可以自己去試試:

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

	/**
	 * main()方法簡(jiǎn)述(后面這個(gè)dot必不可少).
	 * <p>這就是為了測(cè)試注釋<br>
	 * 沒(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ī)范的.
	 * <p>我發(fā)現(xiàn)只有有返回值的方法才可以使用return標(biāo)簽<br>
	 * 沒(méi)有return硬是要用,只會(huì)在javadoc時(shí)候報(bào)錯(cuò)
	 * @param a 輸入的第一個(gè)int類(lèi)型的參數(shù)
	 * @param b 輸入的第二個(gè)int類(lèi)型的參數(shù)
	 * @return add 兩個(gè)數(shù)的和運(yùn)算結(jié)果
	 */
	public int haveReturn(int a,int b){
		int add=0;
		add=a+b;
		return add;
	}

}
登錄后復(fù)制

有幾個(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必不可少).
	 * <p>這就是為了測(cè)試注釋<br>
	 * 沒(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ù)制

你一定發(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)一行注釋?zhuān)蝗サ?和空格之后,就一股腦傳過(guò)去,注意到生成的文檔是HTML類(lèi)型的,所以只要在程序中注釋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ě)類(lèi)注釋、方法注釋非常簡(jiǎn)單,只要在類(lèi)、方法前敲擊/**,再按回車(chē),系統(tǒng)就會(huì)自動(dòng)添加,并且系統(tǒng)如何添加也是我們可以修改的

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

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

476d45d9467699fcc4030e1c7fbac4b.png

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

df2a9ecab5dc8ac44f26ec73b9b5dff.png

f58fbd4cf49be3e4ceff1f066cbe8b7.png

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

相關(guān)推薦:java入門(mén)教程

以上就是javadoc規(guī)范介紹的詳細(xì)內(nèi)容,更多請(qǐng)關(guān)注php中文網(wǎng)其它相關(guān)文章!

java速學(xué)教程(入門(mén)到精通)
java速學(xué)教程(入門(mén)到精通)

java怎么學(xué)習(xí)?java怎么入門(mén)?java在哪學(xué)?java怎么學(xué)才快?不用擔(dān)心,這里為大家提供了java速學(xué)教程(入門(mén)到精通),有需要的小伙伴保存下載就能學(xué)習(xí)啦!

下載
來(lái)源:csdn網(wǎng)
本文內(nèi)容由網(wǎng)友自發(fā)貢獻(xiàn),版權(quán)歸原作者所有,本站不承擔(dān)相應(yīng)法律責(zé)任。如您發(fā)現(xiàn)有涉嫌抄襲侵權(quán)的內(nèi)容,請(qǐng)聯(lián)系admin@php.cn
最新問(wèn)題
開(kāi)源免費(fèi)商場(chǎng)系統(tǒng)廣告
最新下載
更多>
網(wǎng)站特效
網(wǎng)站源碼
網(wǎng)站素材
前端模板
關(guān)于我們 免責(zé)申明 意見(jiàn)反饋 講師合作 廣告合作 最新更新
php中文網(wǎng):公益在線php培訓(xùn),幫助PHP學(xué)習(xí)者快速成長(zhǎng)!
關(guān)注服務(wù)號(hào) 技術(shù)交流群
PHP中文網(wǎng)訂閱號(hào)
每天精選資源文章推送
PHP中文網(wǎng)APP
隨時(shí)隨地碎片化學(xué)習(xí)
PHP中文網(wǎng)抖音號(hào)
發(fā)現(xiàn)有趣的

Copyright 2014-2025 http://www.miracleart.cn/ All Rights Reserved | php.cn | 湘ICP備2023035733號(hào)