是否可以在摘要注释中包含c#定义？

Question

是否可以在摘要注释中使用ac#definition？而不是对象列表

/// <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>

我想List<Object>在摘要中专门使用

/// <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>

Answer 1

如果您不想使用<see cref=""/>表示法创建链接,则必须转义尖括号,如下所示:

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

毕竟,它仍然是XML.

但是,如果要使用<see cref=""/>表示法进行引用,则无法指定特定的类型参数(在本例中Objects),但您可以指定开放的泛型类型,如下所示:

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

这将List<T>在文档中创建一个链接.不幸的是,你无法取代T; XML文档不支持(但希望将来会这样).