在GhostDoc的課堂描述中使用cref

我剛開始使用GhostDoc，所以我希望我的問題不是一個愚蠢的問題。我想通過引用其方法Method1來記錄Class1。所以，我在Class1的描述中使用了cref，如下所示。在GhostDoc的課堂描述中使用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沒有「綁定」，即，在文檔中下備註它說：「最有趣的方法是[方法1]」（用沒有鏈接到Method1）。我怎樣才能讓鏈接顯示？

來源

2014-04-15 user3537808

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

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

其中myNameSpace對象是你的命名空間。

通常很容易找到正確的語法 - 打開項目的XML文檔，編譯項目，查看生成的XML註釋文件的語法。

對於方法，這將是

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

我們不介意回答GhostDoc問題，這樣，但你通常你會得到更快的幫助時，我們的社區論壇上問你的問題 - http://community.submain.com

謝謝！

來源

2014-04-16 06:42:35 sergeb

謝謝，它現在部分工作：它只適用於如果參數是System對象（int，字符串等），如果方法1的簽名是public void Method1（Class2 a），並且我使用，然後在文檔中正確顯示爲Method1（Class2）但沒有鏈接！如何顯示鏈接？ – user3537808

這裏是你如何引用它 - <看到cref =「M：MyNamespace.Class1.Method1（T：MyNamespace.Class2）」/> – sergeb

仍然無法正常工作。文檔中的結果是[M：MyNamespace.Class1.Method1（T：MyNamespace.Class2）]（當然沒有鏈接） – user3537808

在GhostDoc的課堂描述中使用cref

回答

相關問題