main方法中变量的Javadoc文本

main方法中变量的Javadoc文本,java,javadoc,Java,Javadoc,我想知道是否有可能在类的主方法中为重要变量生成Javadoc文本 public static void main(String[] args) { /** * Writes statistical information to results file */ BufferedWriter report_stream = null; .... 这是一个变量的示例,我希望在Javadoc中显示该变量的描述。 谢谢 否。Javadoc用于生成API的文

我想知道是否有可能在类的主方法中为重要变量生成Javadoc文本

public static void main(String[] args) {

    /**
     * Writes statistical information to results file
     */
    BufferedWriter report_stream = null; 
    ....
这是一个变量的示例,我希望在Javadoc中显示该变量的描述。
谢谢

否。Javadoc用于生成API的文档,而不是实现


但是,如果需要,您可以将缓冲编写器包装在另一个类中并编写文档。

Nope。也就是说,这样做的必要性有点可疑;如果一个方法足够大,以至于它的变量需要外部文档,那么它可能会出错。(如果你想解释代码,而不是文档化代码,那么你可能会追求“识字编程”的风格。)