Можно ли включить определения c # в сводные комментарии?

Question

Можно ли использовать определение ac # внутри сводного комментария?Вместо Список объектов

/// <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-документация этого не поддерживает (но, надеюсь, в будущем).