代码注释:您是否将代码注释放在Interfaces或Concrete类上,或两者兼而有之？

Question

记录类和接口的最佳实践是什么？假设您有一个名为Foo的具体类,它派生自一个名为IFoo的接口.你在哪里提出你的方法评论？您是否在界面以及具体类上复制了您的注释？

以下是注释重复的示例:

public class Foo : IFoo
{
    /// <summary>
    /// This function does something
    /// </summary>        
    public void DoSomething()
    {
    }
}

public interface IFoo
{
    /// <summary>
    /// This function does something
    /// </summary>        
    void DoSomething();
}

Answer 1

我会对两者发表评论.

在接口上,我会评论接口成员和用法背后的意图.

在实现时,我会评论具体实现的原因.

Answer 2

我把它们都放进去了，但保持它们同步很痛苦，当有疑问时，我只把它们放在界面上。

我这样做是因为我喜欢使用代码时的工具提示，它几乎应该总是使用界面......