如何为我们的代码生成文档,比如javadocs?

如何为我们的代码生成文档,比如javadocs?,java,notepad++,javadoc,Java,Notepad++,Javadoc,提交代码文档对于维护软件产品非常重要。我正在使用notepad++编写java代码。我安装了它的一个插件NppDocIt,它通过按ctrl+alt+shift+D插入自动注释。了解方法很好,但我想生成代码文档,例如java文档 更新-1 谢谢你的指导,我学到了很多 我尝试生成javadoc,如下所示: F:\Java\Tomcat\webapps\ROOT\WEB-INF\classes>javadoc -d "C:/docs" -sourcepath -package "com/i18n

提交代码文档对于维护软件产品非常重要。我正在使用notepad++编写java代码。我安装了它的一个插件NppDocIt,它通过按ctrl+alt+shift+D插入自动注释。了解方法很好,但我想生成代码文档,例如java文档

更新-1 谢谢你的指导,我学到了很多

我尝试生成javadoc,如下所示:

F:\Java\Tomcat\webapps\ROOT\WEB-INF\classes>javadoc -d "C:/docs" -sourcepath -package "com/i18n/source/i18n" -subpackages com
javadoc: error - Illegal package name: "com/i18n/source/i18n"
1 error
我的包驻留为:

com
  |--i18n
       |--resources
            |--bundles
                  |--labelsBundle
请告诉我哪里错了

更新-2
回答:

  • 我在一个文件夹中添加了所有java文件
  • 创建了一个文件夹,例如c:/docs
  • 从命令行
    javadoc-d“C:/docs”*.java运行此命令
    

    并成功生成了我的代码文档

  • 衷心感谢stackoverflow和本帖的参与者

    你究竟为什么要使用notepad++来用Java这样的语言编程?您应该使用IDE,如Eclipse或Netbeans。它们具有生成JavaDoc的函数(也可以使用“JavaDoc”从命令行完成)。你试过谷歌搜索“如何生成JavaDoc”吗?
    JavaDoc
    是一个工具,它扫描java源代码中的注释,以便创建html文档(就像你链接的那样)。如果您已经在编写有效的javadoc样式的注释,那么只需要运行该实用程序:我同意它可能与这个问题无关。然而,正如OP提到的,代码文档对于代码维护是必不可少的,IDE的使用也是如此。使用文本编辑器维护(重构、调试)代码很有趣。可能重复javadoc生成器工具链接的投票