Tag的一些慣例
一些Tags的說(shuō)明
- @author：作者的姓名
- @version：版本號(hào)
- @param：對(duì)于參數(shù)的描述
- @return：對(duì)于返回內(nèi)容的描述
- @exception (和@throws是同義詞)：異常類的名稱和描述
- @see：表示去查看參考資料
- @since：表示這個(gè)變更或特性從什么時(shí)候或版本號(hào)等（由該標(biāo)簽中聲明的內(nèi)容決定）開始存在的
- @serial：用于表示序列化的字段（include | exclude）
- @deprecated：表示被棄用
- @link：用法{@link package.class#member label}驹饺。插入一個(gè)帶標(biāo)簽的鏈接楼入，可以指向特定包、類或指定類的成員名稱的文檔。
- @literal：用法{@literal text}自晰。用來(lái)顯示那些不用被HTML標(biāo)記或嵌套javadoc標(biāo)簽解析的文本掷酗。
Tags的順序
按照下面的順序?qū)憈ags：
- @author (僅用于類和接口胡岔，必須的)
- @version (僅用于類和接口讯沈，必須的)
- @param (僅用于方法和構(gòu)造函數(shù))
- @return (僅用于方法)
- @exception (和@throws是同義詞)
- @see
- @since
- @serial (或者@serialField祝迂，@serialData)
- @deprecated
對(duì)多個(gè)相同tags的排序
按照下面的慣例來(lái)使用多個(gè)相同tags。如果需要型雳，可以用空白行（單*）來(lái)隔離這些包含多個(gè)相同tags的組当凡。
- 多個(gè)@author標(biāo)簽，應(yīng)該按照發(fā)生時(shí)間順序排列沿量，最早的發(fā)在最上面。
- 多個(gè)@param標(biāo)簽朴则，應(yīng)該按照參數(shù)的聲明順序排列权纤。
- 多個(gè)@throws標(biāo)簽（或@exception）汹想，應(yīng)該按照異常名稱的字母順序排列。
必須的Tags
按照慣例撤蚊，每一個(gè)參數(shù)都應(yīng)該有一個(gè)@param標(biāo)簽，即使描述很明顯侦啸。每一個(gè)返回不是void的方法都應(yīng)該有一個(gè)@return標(biāo)簽，即使這個(gè)標(biāo)簽和方法的描述內(nèi)容重復(fù)光涂。
