C# 将单元测试代码转换为XML注释
我试图对我向客户公开的API(.Net)进行注释。 我通过使用XML注释并通过SandCastle进行提取来实现这一点 这一切都很好,但是我已经对API进行了单元测试,并且认为这些代码最好放在示例标记中 那么,有人知道提取单元测试代码并放入示例标记的好方法吗? 还是有人有更好的想法C# 将单元测试代码转换为XML注释,c#,documentation,sandcastle,C#,Documentation,Sandcastle,我试图对我向客户公开的API(.Net)进行注释。 我通过使用XML注释并通过SandCastle进行提取来实现这一点 这一切都很好,但是我已经对API进行了单元测试,并且认为这些代码最好放在示例标记中 那么,有人知道提取单元测试代码并放入示例标记的好方法吗? 还是有人有更好的想法 当然,我用API重新发布了单元测试,但最好将它们放在文档中。我看到Jon Skeet给出了一个答案,这需要一些工作: 有人去实施了吗? 有没有更简单的方法? 这个问题是关于从cs文件中获取metod主体的: 我制定
当然,我用API重新发布了单元测试,但最好将它们放在文档中。我看到Jon Skeet给出了一个答案,这需要一些工作: 有人去实施了吗? 有没有更简单的方法? 这个问题是关于从cs文件中获取metod主体的: 我制定了一个项目来实现这一点:
我正在使用NUnit和Sandcastle帮助文件生成器。请查看有关代码块组件的Sandcastle帮助文件生成器文档 下面是我如何将单元测试代码放置在示例标记中的示例:
/// <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;
}
致以最良好的祝愿
#region ToString_a
[Test]
public void ToString_a()
{
CSVDataRow res = new CSVDataRow
{
Data = "1;2;3"
};
Assert.AreEqual(res.ToString(), res.Data);
}
#endregion