c# - 代码注释 : Do you put your code comments on Interfaces or on Concrete classes, 或两者?

标签 c# comments xml-comments

<分区>

记录类和接口(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();
}

最佳答案

我会对两者发表评论。

在接口(interface)上,我会评论接口(interface)成员和用法背后的意图。

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

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

相关文章:

c# - yield 返回的工作模式

c# - Json.NET 和混淆,反序列化不起作用

python - 如何从Python代码库中注释/删除所有打印语句?

c# - 方法的 XML 摘要的片段在哪里?

c# - 如何在 C# 中的 XML 文档注释之间跳转?

c# - 调用 RPG 程序的 iSeries 存储过程不向程序返回值

c# - 将 unicode 转换为实际字符 C#

android - 如何将 Disqus 集成到我的 Android 应用程序中?

php - 删除 WordPress 上的 'Leave a comment' 链接

c# - 更改派生类中属性的 xml 描述