2011-11-28 85 views
1

我注意到Eclipse自動添加了一個@author標籤,它的名稱位於新Java類的頂部。我也注意到,有可像其他標籤@version@link@code@value@see ...Eclipse標籤的用途是什麼 - 像@author,@version,@link?

難道只是已經形成,使得代碼中的另一個「公約」保持良好的記錄?還是有其他目的?

我試圖找到一個網站,可以給出更好的描述標籤和他們的用法,但我沒有任何運氣。

+8

這些是javadoc標籤。 http://docs.oracle.com/javase/1.4.2/docs/tooldocs/windows/javadoc.html#javadoctags – evan

+0

感謝您的鏈接。這真的有幫助。 – Gautam

+2

@evan:我認爲你可以詳細闡述一下,然後將其作爲答案發布。 – BoltClock

回答

6

這些是與Javadoc機制相關的Javadoc標籤。當你生成Javadoc(在Eclipse菜單中有一個選項)時,這些鏈接將被正確解釋,並且Javadoc將會更加詳細。請參閱評論中的鏈接,瞭解所有可用標籤的列表。

低估您不會記錄的文檔的力量。

+0

這些不是註釋,但它們是javadoc標籤。 –

+0

謝謝我只是在Java文檔中查找它,你是對的,'註釋補充javadoc標籤'。我現在正在改變它。 – talnicolas