如何在Fitnesse测试中生成夹具的文档

Question

我在使用Fitnesse几年的项目中工作。其中一个重要的主题是维护和添加新测试。为了避免重复，最好有一些现有fixtures的文档。 您是否知道可以从fixtures或C#代码生成C++文档的工具？

Answer 1

我主要使用Java工作，并且遇到了基于JavaDoc（相当于xmldoc）为其灯具生成文档的团队。他们创建了自己的源后处理器，根据这些注释生成描述每个夹具和每个方法的维基页面。 我确信.Net环境可以创建类似的东西（如果它已经不存在）。

我个人的经验是，为我的代码编写评论时，编写文档的文档超出了我所能达到的范围。对于我的开源库中的每个主要灯具，我创建了一个概述页面，其中列出了所有方法（定义的域特定语言），下面我添加了多个示例测试页面，显示了灯具的运行情况。此外，我为我的灯具创建了FitNesse验收测试，它也提供了文档（各种）。所有这些都是手工工作，我认为这对于让人们从灯具中受益非常重要。

所以我相信你可能会花时间手工编写文档，而不是花费时间来设置生成器并确保你的灯具代码中存在正确的输入....这只是我的2个。