c# - 是否有首选的方法来记录实现接口的方法？

Question

我想知道是否有某种方法可以做到这一点，或者即使应该这样做？我的想法很快就转向使用方法属性，因为它是一种元数据，但我不确定是否有任何用于此目的。现在，我只是使用 XML 注释<remark>标签来判断一个方法何时实现了某个接口。但这当然根本不是元数据的结构化形式。

也许自动代码文档系统已经可以通过代码解析这些信息，但对于阅读实际代码以便更轻松地遵循它的任何人来说，它仍然很有用。

Answer 1

看看 GhostDoc。它是一个免费的视觉工作室插件。它有菜单和简单的键盘快捷键来自动生成文档注释。它也足够聪明，可以从方法的名称中推断出一些功能。例如，如果您有诸如“public void SavePerson()”之类的方法，当在该方法中时，您按 Ctrl+Shift+D，它将生成预填充诸如“此方法用于保存人员”之类的注释。

如果你的类实现了一个接口，它也会记录下来。如果您的方法采用参数，它将交叉引用这些类型。

您仍然需要输入大量文本来为您的类/方法/属性实际所做的事情增加价值，但 GhostDoc 是在代码文档中生成基本脚手架、交叉引用、继承层次结构和接口详细信息的好方法。

Answer 2

如果您的意思是实现接口的类列表，您可以使用<seealso>文档标题的标签。

/// <summary>
/// Interface that AutoCAD commands are required to implement.
/// </summary>
/// <seealso cref="My.Namespace.ClassThatImplementsThisInterface"/>
/// <seealso cref="My.Namespace.AnotherClassThatImplementsThisInterface"/>
public interface IMyInterface

您也可以在方法上执行此操作以引用接口方法：

public class ClassThatImplementsThisInterface : IMyInterface
{
    /// <summary>
    /// </summary>
    /// <seealso cref="My.Namespace.IMyInterface.InterfaceMethod" />
    public void InterfaceMethod()
    {
    }
}

我只在 C# 中使用过一个文档生成器，并且当时没有使用上述方法，所以我不能说这是理所当然的，但我相信生成器应该获取这些引用并在文档中创建指向所引用方法的链接/类/接口。