Question

我刚开始使用GhostDoc，所以我希望我的不是一个愚蠢的问题。我想通过引用它的方法Method1来记录Class1。所以，我在Class1的描述中使用cref如下。

/// <summary>
/// Use this class to do a lot of things.
/// </summary>
/// <remarks>
/// The most interesting method is <see cref="Method1"/>
/// </remarks>
public class Class1
{
    public void Method1(int a)
    { }
}

在使用GhostDoc Pro构建帮助文件后，我注意到cref没有“绑定”，也就是说，在备注下的文档中它说： “最有趣的方法是[Method1]”（没有指向Method1的链接）。如何显示链接？

Answer 1

您需要使用完全限定的方法名称，例如

<see cref="M:MyNamespace.Class1.Method1(System.Int32)"/>

其中MyNamespace是您的命名空间。

通常，很容易找到正确的语法 - 打开项目的XML文档，编译项目，查看生成的XML注释文件的语法。

对于

的方法

M:<namespace>.<class>.<method name>(<parameters>):<return type>

我们不介意在SO上回答GhostDoc问题，但在社区论坛上提问时，您通常可以获得更快的帮助 - http://community.submain.com

谢谢！

在GhostDoc的类描述中使用cref

1 个答案: