VisualStudio | Сводка - настраиваемый тег IntelliSense
Есть ли способ добавить собственные теги для summary в VisualStudio 2017, чтобы увидеть их в IntelliSense?
У меня есть объект HtReturnStatus, содержащий HtErrorCode. В нашей библиотеке около 100 HtErrorCode. Поэтому для нас было бы улучшением, если бы можно было объявить коды ошибок, которые может возвращать метод.
(При необходимости доступен ReSharper)
public class Foo
{
/// <summary>
/// This method returns error codes.
/// </summary>
/// <ErrorCodes>
/// <see cref = "HtErrorCode.USER_WrongCredentials"/> / <see cref = "HtErrorCode.USER_UserNotFound"/>
/// </ErrorCodes>
public static HtReturnStatus Login()
{
return HtReturnStatus.Failed(HtErrorCode.USER_WrongCredentials);
}
}
Намекать
Если вы хотите добавить пользовательские теги в свой XML-файл документации, взгляните на решение от Peter Macej (https://stackoverflow.com/a/49757547/6229375)
Ответы 1
Вам нужна информация о кодах ошибок, которая будет отображаться в IntelliSense или в сгенерированной документации? Если используется IntelliSense, вы должны поместить его в какой-либо существующий тег XML-документа верхнего уровня. Мне кажется, самое лучшее <возвращается>. Например:
/// <summary>
/// This method returns error codes.
/// </summary>
/// <returns>
/// The <see cref = "HtErrorCode"/> object with one of the following error codes:
/// <see cref = "HtErrorCode.USER_WrongCredentials"/> or <see cref = "HtErrorCode.USER_UserNotFound"/>.
/// </returns>
Если эта информация длиннее, я бы поместил ее в тег <remarks>.
Если вам действительно нужен отдельный блок верхнего уровня, как в вашем примере, это можно сделать. Но это не будет отображаться в Intellisense, только в сгенерированной документации. Не знаю, как насчет других инструментов, но наш VSdocman (я его разработчик) поддерживает именно такой пользовательские теги.
VSdocman может создавать документацию и редактировать XML-комментарии (у него есть редактор комментариев WYSIWYG). Но он не расширяет встроенный IntelliSense.
Ссылка на настраиваемые теги не работает.
@Marcel: ссылка исправлена.
Первично мне это нужно в IntelliSense. Значит,
VSdocmanпредназначен только для документации?