是否有Java註釋來生成參數文檔？

Question

項目Hadoop等有一噸的parameters，但所有的文檔被手動從XML產生，而不是從code到來。

有沒有做一些的可以發這個文件的註釋的方法嗎？

public static final String MAP_SORT_SPILL_PERCENT = "mapreduce.map.sort.spill.percent"; 

    <name>mapreduce.map.sort.spill.percent</name> 
    <value>0.80</value> 
    <description>The soft limit in the serialization buffer. Once reached, a 
    thread will begin to spill the contents to disk in the background. Note that 
    collection will not block if this threshold is exceeded while a spill is 
    already in progress, so spills may be larger than this threshold when it is 
    set to less than .5</description> 

Answer 1

您可以使用@參數Javadoc標記生成代碼中的參數信息，如this example from the wikipedia page：

/** 
* Short one line description.       
* 
* @param variable Description text text text.   
* @return Description text text text. 
*/  
public int methodName (...) { 
    // method body with a return statement 
} 

這是甲骨文是如何生成的Java (example)