我的团队负责为我们编写的大型系统开发API.我们需要提供示例代码,以便使用我们的API的其他开发人员可以学习如何使用它.我们一直在使用xml文档注释来记录代码.例如.
/// <summary>Summary here</summary>
/// <example>Here is an example <code>example code here</code> </example>
public void SomeFunction()
然后我们使用Sandcastle并构建我们需要的帮助文件(chm和在线网站).
当示例代码不起作用时,这是非常尴尬的,这通常是因为某些功能已更改或一个简单的错误.
有没有人做过这样的事情,还配置了单元测试来运行示例代码,以便知道它们在构建期间工作？