【问题标题】:Commenting overridden methods评论被覆盖的方法
【发布时间】:2018-07-04 02:58:51
【问题描述】:

你评论被覆盖的方法吗?

这是一个普遍的问题,如果它不是 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
}

【问题讨论】:

    标签: .net inheritance comments


    【解决方案1】:

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

    【讨论】:

      猜你喜欢
      • 2011-12-13
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2014-07-29
      • 1970-01-01
      • 2014-05-22
      • 1970-01-01
      • 2021-03-19
      相关资源
      最近更新 更多