在C＃中使用C＃的xml註釋cref屬性

在C＃中，我嘗試使用<請參閱cref =「blah」/ >以引用包含params關鍵字的方法簽名。我知道這將參數列表轉換爲數組，但我甚至無法弄清楚如何引用CREF屬性中的數組。我在搜索中找不到任何東西，也沒有人知道我有任何想法。編譯器在方括號中窒息。我嘗試了各種不同的組合，使用花括號，使用Array類，但沒有任何工作。有人知道嗎？在C＃中使用C＃的xml註釋cref屬性

來源

2009-04-17 Matt H

的ECMA 334標準PDF附件E包含的XML文檔註釋一個體面的概述。您可以下載標準：

http://www.ecma-international.org/publications/standards/Ecma-334.htm

具體來說，你要部分E.3.1，頁開始496.

類似的內容也是在MSDN（MSDN雖然似乎有可怕導航這個主題，因此很難找到其他部分）：

http://msdn.microsoft.com/en-us/library/aa664787(VS.71).aspx

相當於E.3.1：

http://msdn.microsoft.com/en-us/library/aa664807(VS.71).aspx

您也可能會發現黑白文檔有用：

http://www.go-mono.com/docs/[email protected]%3amdoc(5)

Specfically的「CREF格式」部分涵蓋了ID字符串約定。

來源

2009-04-17 19:09:32 jonp

+1對於研究和參考的轉換申請，但我仍然認爲這個答案會從一個例子擬合受益OP的要求。 – Basic 2015-12-14 21:16:39

當鏈接停止工作時，這個答案將非常無用。 – James 2017-10-09 13:05:07

你只是離開了帕拉姆關鍵字放在類型是這樣的：

/// <summary> 
    /// <see cref="Method(string[])"/> 
    /// </summary> 
    public static void Main() 
    { 
     Method("String1", "String2"); 
    } 

    public static void Method(params string[] values) 
    { 
     foreach (string value in values) 
     { 
      Console.WriteLine(value); 
     } 
    }

來源

2009-04-17 16:35:48

按照B.3.1 ID string format文章，引用數組與[方括號]（帶有可選lowerbound:size符），這樣做，但如果你只是想引用某類型的數組（或者甚至是一個對象數組），你可以「T只寫

<see cref="Object[]"/>

，而不是你需要指定你正在做與T:前綴類型引用，就像

<see cref="T:Object[]"/>

這似乎並沒有引用一個方法的具體超載時，如

<seealso cref="String.Join(String, String[])"/>

來源

2009-05-06 01:35:04

在C＃中使用C＃的xml註釋cref屬性

回答

相關問題