2011-02-17 61 views
42

據我所知,在C#類型/方法的XML註釋,有可能引用泛型類型的標籤,像這樣:引用泛型類型的XML代碼註釋

///<see cref="name.space.typename&lt;T&rt;(paramtype)"> 

但我認爲,還有另一種語法,這是不笨拙?有什麼,擺脫這些html實體'<'?我現在找不到它。有人可以幫忙嗎?

回答

58

這裏有一個關於文件的好文章:C# XML documentation comments FAQ

編譯器團隊決定通過允許替代語法 引用泛型類型和方法,以提高 這 在文檔評論中。具體來說, 而不是使用打開和關閉 尖括號,使用打開和關閉大括號 是合法的。接着上面的例子 將成爲:

class Program 
{ 
    /// <summary> 
    /// DoSomething takes a <see cref="List{T}"/> 
    /// </summary> 
    void DoSomething(List<int> al) { } 
} 

所以,你的情況:

///<see cref="name.space.typename{T}(paramtype)" /> 
+5

是的,但大括號做在Visual Studio(2005..2012)智能感知爲'現身{T}`,而不是'`。 – 2013-05-15 03:29:00

7

使用大括號:

///<see cref="name.space.typename{T}(paramtype)">