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＃中只使用过一个文档生成器，并且当时没有使用上述方法，所以我不能说这是理所当然的，但我相信生成器应该选择这些引用并在文档中创建一个链接引用的方法/类/接口。

是否有一种首选方法来记录实现接口的方法？

2 个答案: