建站
咨詢
售后
建站咨詢
新聞中心
/** ... */ 格式。Java 文檔注釋
站在用戶的角度思考問題，與客戶深入溝通，找到瑤海網(wǎng)站設(shè)計(jì)與瑤海網(wǎng)站推廣的解決方案，憑借多年的經(jīng)驗(yàn)，讓設(shè)計(jì)與互聯(lián)網(wǎng)技術(shù)結(jié)合，創(chuàng)造個(gè)性化、用戶體驗(yàn)好的作品，建站類型包括：成都網(wǎng)站設(shè)計(jì)、做網(wǎng)站、企業(yè)官網(wǎng)、英文網(wǎng)站、手機(jī)端網(wǎng)站、網(wǎng)站推廣、空間域名、網(wǎng)絡(luò)空間、企業(yè)郵箱。業(yè)務(wù)覆蓋瑤海地區(qū)。
在 Java 中，文檔注釋（也稱為 Javadoc）是一種用于生成 API 文檔的注釋格式，它可以幫助開發(fā)者更好地理解代碼的功能和用法，同時(shí)也方便其他開發(fā)者快速查找和使用這些代碼，本節(jié)將詳細(xì)介紹 Java 文檔注釋的基本語法、標(biāo)簽和示例。
基本語法
Java 文檔注釋以 /** 開頭，以 */ 結(jié)尾，在這兩個(gè)標(biāo)記之間，可以包含一些特殊的注釋標(biāo)簽，用于描述類、方法、字段等元素的信息。
/**
* 這是一個(gè)示例類。
*/
public class ExampleClass {
// ...
}
常用標(biāo)簽
Javadoc 支持多種標(biāo)簽，用于描述不同類型的信息，以下是一些常用的標(biāo)簽：
1、@author：表示類的作者。
2、@since：表示自哪個(gè)版本開始使用此元素。
3、@version：表示元素的版本號(hào)。
4、@param：表示方法的參數(shù)。
5、@return：表示方法的返回值。
6、@throws：表示方法可能拋出的異常。
7、@see：表示與此元素相關(guān)的其他元素。
8、@link：表示指向其他資源的鏈接。
9、@deprecated：表示此元素已被廢棄，不建議使用。
10、@serial：表示元素的序列化 ID。
11、@value：表示配置文件中的鍵值對。
12、@innerclass：表示內(nèi)部類或嵌套類。
13、@outerclass：表示外部類或頂層類。
14、@summary：表示元素的簡短描述。
15、@description：表示元素的詳細(xì)描述。
16、@param：表示方法的參數(shù)。
17、@return：表示方法的返回值。
18、@throws：表示方法可能拋出的異常。
19、@exception：表示方法可能拋出的異常，已過時(shí)，建議使用 @throws 標(biāo)簽代替。
20、@note：表示與元素相關(guān)的額外信息。
21、@example：表示一個(gè)使用示例。
22、@requires：表示使用此元素所需的條件。
23、@ensures：表示此元素保證的結(jié)果。
24、@signal：表示此元素可能引發(fā)的信號(hào)事件。
25、@threadsafety：表示此元素的線程安全性。
26、@serial：表示元素的序列化 ID。
27、@serialData：表示元素的序列化數(shù)據(jù)。
28、@serialField：表示元素的序列化字段。
29、@indextable：表示元素在索引表中的位置。
30、@deprecated：表示此元素已被廢棄，不建議使用。
31、@value：表示配置文件中的鍵值對。
32、@linkplain：表示指向其他資源的鏈接，類似于 Javadoc 的超鏈接功能。
33、@link：表示指向其他資源的鏈接，類似于 Javadoc 的超鏈接功能。
34、@since：表示自哪個(gè)版本開始使用此元素。
35、@param：表示方法的參數(shù)。
36、@return：表示方法的返回值。
37、@throws：表示方法可能拋出的異常。
38、@exception：表示方法可能拋出的異常，已過時(shí)，建議使用 @throws 標(biāo)簽代替。
39、@note：表示與元素相關(guān)的額外信息。
40、@example：表示一個(gè)使用示例。
41、@requires：表示使用此元素所需的條件。
42、@ensures：表示此元素保證的結(jié)果。
43、@signal：表示此元素可能引發(fā)的信號(hào)事件。
44、@threadsafety：表示此元素的線程安全性。
45、@serial：表示元素的序列化 ID。
46、@serialData：表示元素的序列化數(shù)據(jù)。
47、@serialField：表示元素的序列化字段。
48、@indextable：表示元素在索引表中的位置。
49、@deprecated：表示此元素已被廢棄，不建議使用。
50、@value：表示配置文件中的鍵值對。
51、@linkplain：表示指向其他資源的鏈接，類似于 Javadoc 的超鏈接功能。
52、@link：表示指向其他資源的鏈接，類似于 Javadoc 的超鏈接功能。
53、@since：表示自哪個(gè)版本開始使用此元素。
54、@param：表示方法的參數(shù)。
55、@return：表示方法的返回值。
56、@throws：表示方法可能拋出的異常。
57、@exception：表示方法可能拋出的異常，已過時(shí)，建議使用 @throws 標(biāo)簽代替。
58、@note：表示與元素相關(guān)的額外信息。
59、@example：表示一個(gè)使用示例。
60、@requires：表示使用此元素所需的條件。
61、@ensures：表示此元素保證的結(jié)果。
62、@signal：表示此元素可能引發(fā)的信號(hào)事件。
63、@threadsafety：表示此元素的線程安全性。
64、@serial：表示元素的序列化 ID。
65、@serialData：表示元素的序列化數(shù)據(jù)。
66、@serialField：表示元素的序列化字段。
67、@indextable：表示元素在索引表中的位置。
68、@deprecated：表示此元素已被廢棄，不建議使用。
當(dāng)前標(biāo)題：Java文檔注釋
網(wǎng)頁網(wǎng)址：http://m.fisionsoft.com.cn/article/coeegdd.html
