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

我不知道是否有某种方式来做到这一点，或者即使它应该完成？我的想法很快就转向使用方法属性，因为它是一种元数据，但我不确定是否有这种用途。现在，我只是使用XML注释<remark>标签来告诉方法何时实现某个接口。但是，这当然没有任何结构化的元数据。是否有一种首选方法来记录实现接口的方法？

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

来源

2010-03-30 Jonas

你的意思是类似于实现一个接口的类的列表，但将其记录在接口的源文件中？ – 2010-03-30 08:49:06

我的意思是将其作为实际执行方法的文档，而不是可以具有执行器的类。这一次，我甚至无法在界面中记录文档，因为它是一个.NET Framework界面，除此之外，无论如何，它听起来不是一个好主意，因为编码的实现器可能是不可预测的。 – Jonas 2010-03-30 09:20:23

如果您的意思是类似于实现接口的类的列表，您可以使用文档标头的<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＃中一个文档生成，并在没有使用上述方法所以我不能说这是理所当然的，但我相信发电机应该拿起这些引用，并在文档中创建一个链接到引用的方法/类/接口。

来源

2010-03-30 08:55:47

谢谢！是的，我正在考虑在方法上做这件事。在一个类中列出实现者对我来说听起来不太合适，因为可以对不可预知数量的实现者进行编码。无论如何，参考文献看起来也更好看。我没有想到这些，并会转而使用它们。 – Jonas 2010-03-30 09:19:31

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

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

您仍然需要输入大量文本才能为您的类/方法/属性实际添加值，但GhostDoc是一种很好的方式来生成基本的脚手架，交叉引用，继承层次结构和接口详细信息代码文档。

来源

2010-04-01 13:06:47 Chaitanya

谢谢！这听起来也很有趣，因为编写代码非常繁琐，现在可能占用了我大部分时间。当你是一个完美主义者时，这会变成一种冲突。 ;） – Jonas 2010-04-02 13:08:08

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

回答

相关问题