评论覆盖的方法

Question

你评论覆盖的方法吗？

这是一个一般性问题，如果它不是 100% 适合 Whosebug，请原谅我。除了这个类似的 SO 问题之外，我似乎无法在互联网上找到任何关于此的信息或示例：How to comment/document an override in C#?

示例：

/// <summary>
/// Updates this sample code.
/// </summary>
public virtual void Update()
{
    // do something
}

/// <summary>
/// Do you put a comment here?
/// </summary>
public override void Update()
{   
    base.Update()
    // do something else here
}

Answer 1

你应该记录你的方法做了什么，如果实现有任何特殊性，那么你应该评论它。我个人觉得注释越多越好 - 让下一个人更容易调试。

评论覆盖的方法

Commenting overridden methods

.net

inheritance

comments