2011-05-02 94 views
2

是否可以在彙總評論中使用c#定義? 而不是我想專門使用List<Object>摘要是否可以在摘要註釋中包含c#定義?

/// <summary> 
/// Gets a List<Objects> given a Table ID 
/// </summary> 
/// <param name="p_Table">The Table name to search for</param> 
/// <param name="p_Id">The ID field within the p_Table to search for</param> 
/// <param name="ObjectList">A List<Objects> as an out parameter</param> 
/// <returns>A List<Objects></returns> 

回答

6

內如果你不希望創建一個使用<see cref=""/>符號鏈接對象

/// <summary> 
/// Gets a List of Objects given a Table ID 
/// </summary> 
/// <param name="p_Table">The Table name to search for</param> 
/// <param name="p_Id">The ID field within the p_Table to search for</param> 
/// <param name="ObjectList">A List of Objects as an out parameter</param> 
/// <returns>A List of Objects</returns> 

名單,那麼你必須避開尖括號,如下所示:

/// <returns>A List&lt;Objects&gt;</returns> 

畢竟,它仍然是XML。

但是,如果你想使用<see cref=""/>符號做一個參考,你將無法指定特定類型的參數(在這種情況下Objects),但你可以specify the open generic type,就像這樣:

/// <returns>A <see cref="List{T}" /></returns> 

這將在文檔中創建一個鏈接到List<T>。不幸的是,你不能取代T; XML文檔不支持(但是,希望將來)。

+0

謝謝/// A列表<對象>正是我所期待的。 – GAR8 2011-05-02 16:40:07

相關問題