Spring BeanDoc可以帮助我们快速生成Spring的Context文档说明，这样我们可以在不用查看Spring Bean声明文件就可以了解Spring的各项设置，同时提供图形来显示各个Bean直接的依赖关系，bean的继承关系和各项属性等。一个标准的文档同时更容易被理解，而且BeanDoc文档的风格和JavaDoc非常相似，所以你也不会有陌生的感觉。

1 安装：我们可以在Spring BeanDoc的主站点下载到开发包，地址为：http://opensource.atlassian.com/confluence/spring/display/BDOC/Home，下载完毕后我们只需将其解压到某一个目录下，在这个开发包中包含BeanDoc的所有信息：文档、jar包、Demo和源码等。由于BeanDoc的图形是由GraphViz生成，如果你要生成图形的话，你需要去[http://www.graphviz.org]下载graphviz安装包，下载地址为http://www.graphviz.org/Download_windows.php，下载完毕后安装即可。

2 beandoc.properties文件说明：BeanDoc的所有配置项都在beandoc.properties文件中进行设置，所以在利用BeanDoc生成文档之前要了解一些beandoc的各项配置。

BeanDoc的配置项很简单，主要包含以下几种：

• 输入文件，也就是Spring的各个Bean声明文件，通过input.files设置。
• 输出目录，存放beandoc生成的文档，通过output.dir
• graphviz的dot程序路径，生成图形时需要，通过compiler.dotExe设置。
• Html相关设置，如title，copyright,css等，通过html.title，html.footer等进行设置。
• 外部Javadoc路径，Spring的配置文件中会引用到各种java类，BeanDoc可以为这些类添加JavaDoc链接，这样在查看BeanDoc文件时可以快速定位到相应类的JavaDoc API文档，通过javadoc.locations设置。
• 图形相关配置，这里的选项比较多，如设置颜色、布局、图形文件输出类型等，这些可以参考BeanDoc的说明文档。
• 高级选项，如XSL模板。

下面就是一个beandoc.properties文件的模板：
#neccessary info for input ,output and graphics compiler
input.files=WEB-INF/applicationContext.xml
output.dir=docs/beandoc
compiler.dotExe=D:/tools/ATT/Graphviz/bin/dot.exe

#html info
html.title=JTV Power_ACL
html.footer=Copyright (C) yourcompany 2005

#external javadoc path,please end with '.'
javadoc.locations[org.springframework.]=F:\\document\\java_doc\\sourceforge\\springframework\\spring-framework-1.2\\docs\\api
javadoc.locations[com.jtv.]=..\\api

####Graphs setting
#color
graphs.colourBeans[.*Proxy$]=#green
#single line on the graphs
graphs.rankBeans[0]=.*DataSource
#selectively ignore beans on graphing output, All beans will still be documented in HTML by default.
graphs.ignoreBeans[0]=^org\\.springframework.*Property.*Configurer
graphs.ignoreBeans[1]=.*MessageSource
#graph types
graphs.outputType=png

3 生成BeanDoc文档，这个步骤很简单，你可以通过命令行方式或Ant来运行。BeanDoc自动了一个命令行方式的runbeandoc-cli.bat文件，你需要修改一下该文件中classpath设置，这样可以在任何路径都可以有效地运行该命令。在Ant的build.xml文件中，你只需定义一下BeanDoc的Ant Task，然后引用即可。选择你喜欢的运行方式，就可以快速生成BeanDoc文档啦。

注意事项：

1 外部JavaDoc设置，如果你想指定某些开发包的JavaDoc API路径，需要注意一下。BeanDoc默认提供了相关开发包的API路径，如SpringFramework，Jdk和Jakarta的commons包，以下是这些包API的覆盖设置项：
javadoc.locations[org.springframework.]=path for spring api
javadoc.locations[java.]=path for jdk api
javadoc.locations[java.]=path for jdk api
javadoc.locations[org.apache.commons.dbcp.]=path for dbcp api

在javadoc.locations中的名称需要以“.”结尾，配置需注意一下。同时要配置项目的JavaDoc API路径，这是非常必要的。
Javadoc.locations[com.yourdomain.]=path for project javadoc api

2 BeanDoc的Ant Task问题，由于BeanDoc的AntTask并没有使用Ant的ClassLoader特性，而是Java默认的ClassLoader，那么就没法给其设定运行时的ClassPath，所以你在运行Ant之前要自行设置ClassPath，如将Spring、BeanDoc等jar包加入到ClassPath中，否则会出现问题，如无法找到相关的类和资源。这是一个比较麻烦的问题，这里我们重写BeanDoc的AntTask，你就无需担心这个问题啦，下载spring-beandoc.jar。新的BeanDoc的Ant Task的配置如下：
<beandoc classpathRef=”…”>或在beandoc中包含子元素<classpath>

总结：Spring BeanDoc对Spring的xml配置文档化非常有帮助，也更加促进我们对系统的理解，这是一个非常使用的工具。同样特性如StrutsDoc等也有体现。