我可以得到有關丟失的XML文檔的報告嗎

Question

我正在嘗試GhostDoc，StyleCop，CodeIt.Right，FXCop等，以找到一種簡化的方式來添加C＃代碼中的自動生成的XML注釋以及在例如參數更改的情況下更新現有注釋。

GhostDoc Pro似乎運行良好，但無法獲得覆蓋率報告，或者至少無法完全缺少文檔的類。

我如何獲得這樣的報告？

Answer 1

就像您提到的那樣，GhostDoc將為您提供幫助； 您可能只需要更新的版本或正確的版本。

您可以使用v5中的GhostDoc Pro文檔維護功能-它會幫助您查找自動生成的文檔，查找缺少文檔的類/方法以及需要更新（方法簽名不同步）或進行編輯的類/方法。 這是有關v5功能的更多信息-http: //submain.com/blog/ReleasedGhostDocV50.aspx

您提到您還使用CodeIt.Right-您要打開規則GE00005-外部可見的類型和成員應具有XML注釋（Type，Member->應具有XML注釋）。 您還可以在VS中導出列表或在您的構建中生成列表。

GhostDoc和CodeIt.Right都將為丟失的文檔生成XML注釋模板，但是，當然，您以后需要對其進行編輯。