Java：評論中註釋的目的是什麼？

在註釋中放置註釋的目的是什麼（看起來像什麼）？例如，我看到在界面上面的方法如下評論：Java：評論中註釋的目的是什麼？

/** 
* Create saved search 
* REST: POST /lifecycles/savedsearches 
* @param controlParameters control parameters 
* @param search savedSearch object 
* @throws ProcessingException if any processing exceptions 
* @return Updated Object 
*/

我理解的評論的意思，只是想知道爲什麼使用這個語法。

來源

2014-10-31 Jeff Levine

這些註解爲的javadoc工具很重要。當它在分析/**和*/之間的內容時爲類/接口/枚舉/構造函數/方法生成文檔。

對於單個javadoc內容，該工具會生成一個基於HTML的文檔，其中包含多個段落。當它檢測到一個註釋（例如@param）時，它會將相應的@param信息添加到關於方法的Parameters的段落中。例如，檢出String#concat(String str)方法。

另外，看看甲骨文的Javadoc home page

來源

2014-10-31 12:02:21

謝謝 - 非常清楚。它是否也會解析用'//'聲明的註釋？ – 2014-10-31 12:05:26

不可以。只有那些以'/ **'開頭並以*// – 2014-10-31 12:06:05

它被用於javadoc生成。請參閱http://www.oracle.com/technetwork/articles/java/index-jsp-135444.html

來源

2014-10-31 11:54:03 JiriS

這在生成Javadoc時使用。通過這種方式，您可以爲傳遞給函數的每個參數添加解釋性文本，並且可以解釋返回的內容以及可以引發的異常，然後Javadoc生成器會將您的註釋添加到相應位置的方法文檔中。

然後，您可以使用它來根據這些註釋生成記錄代碼的html頁面。

來源

2014-10-31 11:54:16 Simon

如果生成Javadoc，則使用此語法。

http://www.oracle.com/technetwork/articles/java/index-137868.html

來源

2014-10-31 11:55:21 sinclair

Java：評論中註釋的目的是什麼？

回答

相關問題