2015-07-20 6 views
1

Проекты вроде hadoop имеют тонну parameters, но вся эта документация создается вручную из xml, а не из code.Есть ли Java-аннотация для создания документации по параметрам?

Есть ли способ сделать что-то с аннотацией, которая может сгенерировать эту документацию?

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> 

ответ

0

Вы можете использовать @param 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 
} 

Вот как Oracle создает официальный документ для Java (example)

+0

Это параметр функция, это внешний параметр для программы. – Alun

+0

применяются те же правила, не так ли? Вы все равно можете поместить javadoc в свой метод main(), используя аннотацию @param. Если это не то, что вы ищете, можете ли вы подробнее разъяснить этот вопрос? –