相关疑难解决方法(0)

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

记录类和接口的最佳实践是什么?假设您有一个名为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();
}
Run Code Online (Sandbox Code Playgroud)

c# comments xml-comments

9
推荐指数
2
解决办法
1829
查看次数

标签 统计

c# ×1

comments ×1

xml-comments ×1