这个问题已经在这里有了答案: > Automatically Unit Test Example Code 4个
我正在尝试评论我向客户公开的API(.Net).
我通过使用XML注释并通过SandCastle提取来做到这一点.
一切都很好,但是我已经对该API进行了单元测试,并认为将其中的代码很好地放在示例标签中.
那么,有谁知道提取单元测试代码并将其放置在示例标签中的好方法吗?
还是有人有更好的主意?
当然,我使用API重新分发了单元测试,但是最好在文档中包含它们.
解决方法:
我正在使用NUnit和Sandcastle帮助文件生成器.请查看有关代码块组件的Sandcastle帮助文件生成器文档.
这是一个示例如何将单元测试代码放置在example标记中的示例:
/// <summary>
/// Returns a string representation of an object.
/// </summary>
/// <returns>Comma separated string.</returns>
/// <example>
/// <code source="UnitM.CentrallProcessingLib.Tests\Data\CSVDataRowTests.cs" region="ToString_a" />
/// </example>
public override string ToString()
{
return this.Data;
}
这是引用的单元测试(CSVDataRowTests.cs)(应在#region部分中):
#region ToString_a
[Test]
public void ToString_a()
{
CSVDataRow res = new CSVDataRow
{
Data = "1;2;3"
};
Assert.AreEqual(res.ToString(), res.Data);
}
#endregion
最好的祝福.