Как добавить <или> к итоговому тегу в Visual studio? - PullRequest
5 голосов
/ 05 апреля 2010

Как добавить <(меньше) или> (больше) к краткому комментарию в visual studio? Я в Visual Studio 2008.

У меня есть универсальный метод:

public bool IsMemberProtected<T>(Expression<Func<T, object>> expression)

Хотелось бы, чтобы итоговый тег был примерно таким

    /// <summary>
    /// Determines whether a member is protected.
    /// 
    /// Usage: IsMemberProtected<ExampleType>(x => x.Member)
    /// </summary>

Но когда я это делаю, всплывающая подсказка для свойства больше не работает, когда разработчик наводит указатель мыши на метод в коде для просмотра итогового тега.

Мысли?

Ответы [ 2 ]

10 голосов
/ 05 апреля 2010

Вы можете использовать объекты &lt; и &gt;, чтобы задать < и > соответственно.

Обратите внимание, что здесь вы также используете < и > для написания универсального типа. В этом случае существует соглашение, что если вы используете тег cref, то вы можете использовать GenericType{T} вместо более уродливого GenericType&lt;T&gt;. См. здесь для получения дополнительной информации.

Также с этой страницы есть другое предложение, если вам нужно написать много символов < и >, которые вы поместите в раздел CDATA:

/// <summary>
/// This a simple collection which implements <see cref="IEnumerable{T}" />
/// </summary>
/// <example>
/// <![CDATA[
/// SimpleList<int> intList = new SimpleList<int>();
/// ]]>
/// </example>
1 голос
/ 25 сентября 2012

Я думаю, это может вам помочь.

Щелкните правой кнопкой мыши на функции, выберите «Документировать это» например,

public void Function_Name()

становится

/// <summary>
/// Give the details here
/// </summary>
/// <param name=""></param>
/// <returns> you can tel what it returns </returns>
public void Function_Name()

(все это автоматически генерируется).

...