我的團隊負責開發我們也編寫的大型系統的API。我們需要提供示例代碼,以便使用我們的API的其他開發人員可以學習如何使用它。我們一直在使用xml文檔註釋來記錄代碼。 例如。自動單元測試示例代碼
/// <summary>Summary here</summary>
/// <example>Here is an example <code>example code here</code> </example>
public void SomeFunction()
然後,我們使用Sandcastle並構建我們需要的幫助文件(chm和一個在線網站)。
當示例代碼不起作用時,這是相當尷尬的,這通常是因爲某些功能已更改或一個簡單的錯誤。
有沒有人曾經做過這樣的事情,還配置了單元測試來運行示例代碼,以便知道它們在構建期間工作?
我已經完成了一個項目: http://code.google.com/p/addsourcetodocumentation/ – khebbie 2008-12-01 13:34:37