使用对象

首先,wrdoclet是基于javadoc的,因此面向的使用者是java的开发人员。

其次,wrdoclet的主要使用对象是接口服务的提供方。接口服务的提供方往往在提供接口服务的同时需要提供接口文档用来说明接口如何使用。常见的做法是手工编辑一个word文档并罗列提供的接口以及使用细节。这种做法的缺点是维护成本较高,一旦接口发生变化需要及时修改接口文档。因为手工维护,也常常出现疏漏。wrdoclet希望通过自动化生成接口文档来提高文档编写的效率以及正确性。

另外,最新的wrdoclet版本同时支持jdk1.7和jdk1.8。jdk 1.6存在严重bug,因此无法支持。如果你的代码是基于1.6的,那么放在1.7的环境进行接口文档生成应该没有什么问题。

wrdoclet 1.0版本主要针对基于主流的服务框架:Spring MVC, JAX-WS, dubbo, resteasy的主流用法进行接口文档的生成。对于某些特殊的用法可能没有得到很好的支持,如果你在使用过程中遇到这种情况,可以email给我adamslee@outlook.com,我会考虑在后续的版本中添加支持。

results matching ""

    No results matching ""