main 方法中变量的 Javadoc 文本

Question

我想知道是否可以为类的 main 方法中的重要变量生成 Javadoc 文本。

public static void main(String[] args) {

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

这是一个变量的示例，我希望在 Javadoc 中显示其描述。谢谢。

Answer 1

没有。 Javadoc 用于生成 API 文档，而不是实现文档。

但是，如果需要，您可以将缓冲编写器包装在另一个类中并记录该内容。