如何以简单和标准的方式创建类文档？

Question

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

Answer 1

首先，在我看来，安装一个checkstyle，如果您编写了错误或名称约定，这会告诉您代码（带黄色警告），如果您错过了javadoc，也会告诉您。

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

Answer 2

使用Javadocs（如果我是对的）。 Drjava和任何其他Java IDE（如Eclipse）都可以帮助您实现这一目标。

Answer 3

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