派生類或接口實現的源代碼中的XML註釋

Question

與我以前的問題相關。如果我定義一個接口，我會評論它的成員。然後，我不會評論實現類的實現，除非原始評論不再有效。

Resharper對此很好，Visual Studio聲稱這是一個警告。

重要的是，當您使用它們時，通過智能感知顯示繼承的註釋，這幾乎是我唯一真正關心的問題。

你對此有何看法？

感謝

Answer 1

將註釋添加到您的代碼始終是一個很好的做法。如果一個組件是一個私有的或者內部的類，並且它總是通過一個已知的接口或者抽象類來暴露出來，那麼所有的評論都已經存在，那麼你可能只需要評論該類實現的具體內容（例如，如果更多比一個人要看代碼，或者如果你在幾年後回到你的代碼）。這樣就會更容易理解代碼的作用和原因。如果您在生成項目時啓用了XML文檔，則Visual Studio會警告您無證件成員。當我啓用XML文檔生成時，我也在某些類上收到了Resharper警告，但Resharper僅警告具有公開可見性的項目。 爲了縮短文檔工作，我建議首先評論公共類和接口（特別是如果你正在發佈產品庫），以及是否有足夠的時間，內部/私人的。如果您決定不對後者發表評論，請確保您或任何將使用該代碼的人都能輕鬆理解其背後的邏輯和原因。