Текст Javadoc для переменных в основном методе - PullRequest
0 голосов
/ 03 октября 2011

Мне было интересно, можно ли сгенерировать текст Javadoc для важных переменных в основном методе класса.

public static void main(String[] args) {

    /**
     * Writes statistical information to results file
     */
    BufferedWriter report_stream = null; 
    ....

Это пример переменной, описание которой я хотел бы отобразить в Javadoc.Благодарю.

1 Ответ

2 голосов
/ 03 октября 2011

Нет.Javadoc предназначен для генерации документации API, а не реализации.

Однако вы можете обернуть буферизованный писатель в другой класс и документировать это, если требуется.

...