2011-05-02 87 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

相关问题