去年年底,我写了关于我的首次使用 AuthorDoclet 的原型,这是我一直在开发的一个文档工具。我花了一些时间让它准备好首次发布,并且一旦它成熟到可以编译自己的手册,我也做了一些概念上的改动。
令我惊讶的是它工作得有多好,拥有经过测试的文档示例有多方便。我经常需要回到某个代码片段并对其进行修改,只在一个地方编辑它——实际的可运行单元测试,这真的节省了时间。我还尝试实现并使用了一些功能,如内联图片、表格、自动章节/部分编号、自动生成目录等。到目前为止没有问题,除了代码示例调用(你经常在书中看到的代码片段中的编号项目),我提供了所有我的较老的基于 Docbook XML 的工具链提供的功能。
所以如果你需要为可测试的 Java 软件编写文档,请尝试附带的alpha 版本[1]。代码仍然相当原始,但我对管道、处理器、读取器等的整体设计感到满意。不过,核心代码中几乎没有文档,我将在下一版本中添加。如果你想编写改进的目录生成器或其他适合的东西,你非常受欢迎。