评论重写方法

时间:2018-01-24 22:57:29

标签: .net inheritance comments

你评论被覆盖的方法吗?

这是一个普遍的问题,请原谅我,如果它不是100%适合Stackoverflow。除了类似的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
}

1 个答案:

答案 0 :(得分:0)

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