在.NET界面上正確的xml註釋

Question

如果有一個接口和一個實現它的類，並且您希望將它的xml註釋用於VS intellisense或文檔，那麼您將放置xml註釋？在接口的方法或具體的類方法？什麼是正確的方法？

我的想法是把它放在界面中，因爲我們正在使用界面聲明變量。我認爲它是多餘的，如果我也對具體類進行評論，並且看到這可能會導致對同一方法的不同文檔。

任何想法，建議？

Answer 1

您應該在任何公共會員上存檔。如果您已將ISomeInterface.SomeMember實施爲public void SomeMember，則應將其記錄下來。一方面，讀者將把它看作是你的類的一部分，並且只有通過閱讀文檔（如果它不在那裏，他們不知道如何查看），他們是否會知道它是在該界面中定義的。如果它被實現爲void ISomeInterface.SomeMember那麼它就不那麼重要了，因爲它不會被看作是該類的公共接口的一部分。

瞭解有關特定類如何實現給定接口成員的詳細信息有時也很重要。

另一方面，給出一個非常簡短的描述並將人們引導到接口的文檔以獲得更多信息可能是合理的。