c# - 如何在 C# 中评论/记录覆盖？

Question

有时我会覆盖基类中的方法。有时我什至用一个空方法覆盖它们，因为我想要的是防止这种行为。

在过去我会写这样的东西来显示绕过基本方法的意图:

protected override void OnMouseUp(MouseEventArgs e)
{
    // base.OnMouseUp(e);
}

(我知道注释的代码行是一件坏事。我曾经这样做过)

但我想做得更好:

• 如何记录覆盖的意图？特别是:
• 我在覆盖的 XML 中写了什么 ( <summary> ？)文档？

Answer 1

对于文档，我只使用 built-in documentation tags :

/// <summary>Exiting drag mode on mouse up</summary>
protected override void OnMouseUp(MouseEventArgs e)
{
    ...

为了阐明我的意图，我只想发表评论

protected override void OnMouseUp(MouseEventArgs e)
{
    // not calling the base implementation
    ...
}

线

// base.OnMouseUp(e);

给人的印象是调用被暂时注释掉了(也许有人忘了恢复它)