c# - 代码注释: Do you put your code comments on Interfaces or on Concrete classes,还是两者兼有？

This question already has answers here:

Comment the interface, implementation or both?

(9个答案)


1年前关闭。




记录类和接口(interface)的最佳实践是什么。假设您有一个名为Foo的具体类，它是从一个名为IFoo的接口(interface)派生的。您在哪里对方法发表意见？您是否在Interface以及具体类上重复了您的评论？

这是一个注释重复的示例:

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

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

最佳答案

我将对两者都发表评论。

在界面上，我将评论界面成员和用法背后的意图。

关于实现，我将评论具体实现的原因。

关于c# - 代码注释: Do you put your code comments on Interfaces or on Concrete classes,还是两者兼有？，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/1875440/