新聞中心
Java中文檔注釋各字段的含義是什么?例如author表示作者,para表示參數(shù)等
常用Java注釋標(biāo)簽(Java comment
成都創(chuàng)新互聯(lián)公司成立于2013年,我們提供高端網(wǎng)站建設(shè)、成都網(wǎng)站制作公司、成都網(wǎng)站設(shè)計、網(wǎng)站定制、全網(wǎng)營銷推廣、微信平臺小程序開發(fā)、微信公眾號開發(fā)、成都網(wǎng)站營銷服務(wù),提供專業(yè)營銷思路、內(nèi)容策劃、視覺設(shè)計、程序開發(fā)來完成項目落地,為成都水電改造企業(yè)提供源源不斷的流量和訂單咨詢。
tags)
@author 作者
適用范圍:文件、類、方法
(*多個作者使用多個@author標(biāo)簽標(biāo)識,java
doc中顯示按輸入時間順序羅列。)
例:*
@author Leo. Yao
@param 輸入?yún)?shù)的名稱 說明
適用范圍:方法
例:* @param str
the String用來存放輸出信息。
@return 輸出參數(shù)說明
適用范圍:方法
例: *
@return codetrue/code執(zhí)行成功;
* codefalse/code執(zhí)行失敗.
@since
JDK版本
用于標(biāo)識編譯該文件所需要的JDK環(huán)境。
適用范圍:文件、類
例: * @since
JDK1.6
@version 版本號
用于標(biāo)識注釋對象的版本號
適用范圍:文件、類、方法
例: * @version 1.0
@see 鏈接目標(biāo)
表示參考。會在java 文檔中生成一個超鏈接,鏈接到參考的類容。使用中的感覺是@see不需要包路徑,對我這種懶人比較喜歡,相對{@link
}這種既要加大括號,有需要包路徑,我還是選擇偷懶,當(dāng)然你要是不介意使用import導(dǎo)入要link的類,那就可以達(dá)到@see的效果,所以總體來說,還是選擇@see,當(dāng)然兩個在特殊場合下還是用法不一樣的
用法:
@see
#field
@see #Constructor(Type,
Type...)
@see #Constructor(Type id, Type
id...)
@see #method(Type,
Type,...)
@see #method(Type id, Type,
id...)
@see
Class
@see
Class#field
@see Class#Constructor(Type,
Type...)
@see Class#Constructor(Type id,
Type id)
@see Class#method(Type,
Type,...)
@see Class#method(Type id, Type
id,...)
@see
package.Class
@see
package.Class#field
@see
package.Class#Constructor(Type, Type...)
@see
package.Class#Constructor(Type id, Type id)
@see package.Class#method(Type,
Type,...)
@see package.Class#method(Type
id, Type, id)
@see
package
@throws 異常
標(biāo)識出方法可能拋出的異常
適用范圍:方法
例: * @throws IOException If an input or output
exception occurred
@deprecated 解釋
標(biāo)識對象過期
適用范圍:文件、類、方法
@link 鏈接地址
鏈接到一個目標(biāo),用法類似@see。但常放在注釋的解釋中形如{@link …}
例:
/**
* @deprecated As of JDK 1.1,
replaced by
* {@link
#setBounds(int,int,int,int)}
*/
在eclipse中的package explorer 中的java文件中如何顯示創(chuàng)建時間和作者的后綴
要關(guān)聯(lián)到svn庫的,在每一次對java代碼的修改都會記錄時間和作者的。
類似以下的顯示方式:
Intellij idea中新建java 自動添加作者和日期信息,是注釋的,這個哪里配置的。注意:不是eclipse。
file-settings-editor-file and code templates
右邊includes-file header
java.我想在程序的最后再輸出一些文字和數(shù)字 比如“作者”“001",應(yīng)該怎么加,加在哪?請大神明示。
System.out.println("?|?");
System.out.println("作者:XX。");
你是這個意思?
java項目,怎么找出一個作者的代碼?
把項目導(dǎo)入到開發(fā)工具中(ECLIPSE)全局搜索你師兄的名字就知道了。
SEARCH
1,填寫搜索文本
2,填寫搜索文件類型
OK了
如何設(shè)置 Eclipse 創(chuàng)建類時自動添加 自動生成的 作者以及日期注釋
使用Eclipse 編寫Java代碼時,自動生成的注釋信息都是按照預(yù)先設(shè)置好的格式
生成的。
修改作者、日期注釋格式:
打開Windows-Preferences-Java-Code Style-Code Templates,
點擊右邊窗口中的Comments,可以看到有很多選項,
我們便可對此注釋信息模板進(jìn)行編輯。
如我們希望在一個Java文件的開頭設(shè)置作者信息、日期信息。
選擇Types,點擊Edit,將
/**
* @author ${user}
* ${tags}
*/
將${user}刪除,改成你希望顯示的名字
將${tags}刪除,
點擊Insert Variable,選擇Date,這樣就會自動生成日期信息。
在你需要添加注釋的地方點擊Sources-Ganarate Element Comment,
或者使用快捷鍵 Alt+Shift+J ,則 eclipse 自動在該類前面添加注釋。
分享文章:java代碼標(biāo)注作者 java 標(biāo)注
本文地址:http://www.dlmjj.cn/article/dodsghs.html