如何像javadocs一样为我们的代码生成文档



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

更新-1感谢您的良好指导,我学到了很多东西。

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

F:JavaTomcatwebappsROOTWEB-INFclasses>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
答:

  1. 我将所有java文件添加到一个文件夹中
  2. 创建了一个文件夹,例如 c:/docs
  3. 从命令行javadoc -d "C:/docs" *.java运行此命令

    并成功生成我的代码文档

衷心感谢堆栈溢出和此线程的参与者

我在这里发现了一个类似的问题:总是在给定树中生成所有javadoc的通用javadoc命令?

从用户斯蒂安的回答来看,

在Windows上,您可以像这样操作:

生成文件列表:

dir /s /b *.java > file.lst

生成 javadoc:

javadoc -d outputdir @file.lst

最新更新