檢查代碼註釋的Visual Studio文件

我正在尋找將檢查所有.cs文件並報告「代碼註釋覆蓋率」的Visual Studio 2008加載宏或宏。我們公司的標準是所有的C＃類，方法和屬性都是代碼註釋。我有一個很大的解決方案，並且通過手工處理文件浪費了很多時間。如果我有一份報告告訴我哪些文件有代碼註釋，哪些沒有代碼註釋，我可以檢查這些文件。檢查代碼註釋的Visual Studio文件

我不介意寫一些代碼來完成這個，但我不想重新發明輪子。有沒有一個插件或宏來做到這一點？否則，有沒有辦法使用反射或System.CodeDom命名空間來檢查代碼註釋的類？如果我可以將我的類加載到對象模型中，我可能會完成剩下的任務。

來源

2009-09-11 virsum

StyleCop檢查類和類成員的XML文檔。

來源

2009-09-11 21:11:59 dtb

目前我的構建輸出的大部分是StyleCop警告。好消息/壞消息我想:-)。 – DaveE 2009-09-11 22:04:33

謝謝，dtb。這解決了我的迫切需求。不過，我想我會考慮創建一個綠燈/紅燈/黃燈代碼評論覆蓋VS插件。 – virsum 2009-09-14 12:29:33

只需在項目構建設置中啓用XML documentation輸出，然後啓用「所有警告爲錯誤」。您現在將獲得任何未公開的類和非私人或內部成員的錯誤。

對於Visual Studio的Ghost Doc擴展非常適合在這裏減少打字工作，而且它是免費的。

Sandcastle Help File Builder是將所有文檔工作轉化爲漂亮的HTML，CHM或HxS文件的最簡單方式。

最後一件很酷的事情：可能會在您的文檔中包含reference code regions作爲示例。將這些單元測試作爲文檔回收，並確保樣本正確：一石二鳥！ :-)

來源

2009-09-11 21:54:04

檢查代碼註釋的Visual Studio文件

回答

相關問題