main 方法中变量的 Javadoc 文本

发布于 2024-12-07 16:55:25 字数 279 浏览 0 评论 0原文

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

public static void main(String[] args) {

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

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

I was wondering if it is possible to generate Javadoc text for important variables within the main method of a class.

public static void main(String[] args) {

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

This is an example of a variable whose description I would like displayed in Javadoc.
Thanks.

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(1

檐上三寸雪 2024-12-14 16:55:25

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

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

No. Javadoc is for generating documentation of the API, not the implementation.

However you could wrap the buffered writer in another class and document that, if required.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文