Arch-05-01-JavaDoc注释生成文档(java)
使用eclipse生成文档(javadoc)主要有三种方法:
1、在项目列表中按右键,选择Export(导出),然后在Export(导出)对话框中选择java下的javadoc,提交到下一步。
???? 在Javadoc Generation对话框中有两个地方要注意的:
???? (1)javadoc command:应该选择jdk的bin/javadoc.exe
???? (2)destination:为生成文档的保存路径,可自由选择。
?????(3)在第三个对话框的"Extra Javadoc options" 文本框里面加上-encoding UTF-8 -charset UTF-8
???? 按finish(完成)提交即可开始生成文档。
2、用菜单选择:File->Export(文件->导出),剩下的步骤和第一种方法是一样的。
3、选中要生成文档的项目,然后用菜单选择,Project->Generate Javadoc直接进入Javadoc Generation对话框,
?
???? 剩余的步骤就和第一种方法在Javadoc Generation对话框开始是一样的。
?
?
简单漂亮的 javaDoc 生成器
?
http://code.google.com/p/doclava/wiki/GettingStarted
?
?
让开发自动化: 文档化一键通
?
http://www.ibm.com/developerworks/cn/java/j-ap06108/
-使用 UMLGraph 生成当前源代码的 UML图。
-使用 SchemaSpy 创建 实体关系图(ERD),归档数据库中的表格和关系。
-使用 Grand 生成构建目标以及它们之间的关系的 Ant 构建图。
-使用 Doxygen 生成 源代码文档。
-使用 DocBook 制作 用户文档。
?
安装手记
?
1. UMLGraph
?
?(1) 下载 http://www.umlgraph.org/download.html。?后来发现,在 windows 和 maven 环境下,其实不用下载,即使下载了,在 pom.xml 文件中配置?<docletPath>D:\path\to\UmlGraph.jar</docletPath> 也失败,总是提示找不到?org.umlgraph.doclet.UmlGraphDoc
?
?(2)pom.xml 中配置
?
?
?? ? 父工程 /src/site/site.xml?子工程 /yeazhu-web/src/site/site.xml?