2009-11-12 73 views
0

我有一个java项目需要一些文档,Doxygen是唯一的方法吗?java项目的文档生成:我应该使用doxygen吗?

我想用3个字来说明整个项目的文档代码,但也包括体系结构,Makefiles。也许我应该把自己定位到eclipsewiki或类似的东西。

任何帮助,将不胜感激。

+0

谁是文档的(主要)目标受众?你的开发团队只有?内部或外部客户?它需要打印吗? – 2009-11-12 16:17:38

+0

主要目标是我:-)和一些潜在的人感兴趣,并且它可能太大而不能打印 – LB40 2009-11-12 16:20:20

回答

5

最容易使用的是JavaDoc。它一直对我很好。

+0

与特定类或方法没有直接关系的东西可以放在包或概览文件中。 – 2009-11-12 16:16:27

2

您可以使用JavaDoc,并包含overview.html。就个人而言,我已经开始使用Sphinx编写所有内容。它创建了美丽的文档。它可以为Python创建API文档,但我更多地使用它来处理其他语言项目的手写文档。

相关问题