java - 如何以简单和标准的方式创建课堂文档？

Question

我是一名 Java 开发人员，我想以 PDF 格式记录我的项目及其类。
我想知道记录我的项目的最佳方式是什么，它在可视化视图中解释了我的所有类及其继承关系和方法。
我已经对此进行了谷歌搜索，但我刚刚在 IDE 中找到了一些关于代码文档的内容，如下所示：
http ://www.edparrish.net/common/javadoc.html

Answer 1

首先，在我看来，安装一个 checkstyle，它会在代码中告诉你（带有黄色警告），如果你编程错误或命名约定，也会告诉你是否缺少 javadoc。

完成 javadoc 后，您可以创建 javadoc 并导出为 html。稍后，如果您愿意，您可以使用其他工具将 html 导出为 PDF。

Answer 2

我使用 eclipse ，我建议在其中下载并安装 checkstyle 并用作如何正确使用 java doc 文件和包的指南。祝你好运。

Answer 3

使用 Javadocs（如果我是对的）。Drjava 和任何其他 Java IDE（如 Eclipse）都允许您这样做。