Стиль Cop + Resharper управления комментариями

Question

это может показаться тривиальным вопросом, но когда я установил плагин stylecop для resharper, мои комментарии форматируются следующим образом

/// <summary>
/// Gets the gift item.
/// </summary>
/// <param name="uid">
/// The uid.
/// </param>
/// <param name="upc">
/// The upc.
/// </param>
/// <returns>
/// </returns>
Gift GetGift(long uid, string upc);

в отличие от

/// <summary>Gets the gift item.</summary>
/// <param name="uid">The uid.</param>
/// <param name="upc">The upc.</param>
/// <returns></returns>
Gift GetGift(long uid, string upc);

Кажется, я не могу найти способ отключить этот тип форматирования.

Answer 1

Если в Resharper установлен плагин Microsoft Stylecop для Resharper, выберите «Параметры Resharper», «Инструменты», а затем «StyleCop for Resharper».Там вы должны увидеть флажок Использовать отдельные строки для заголовков объявлений.

Answer 2

Дайте GhostDoc попробовать. Это бесплатное расширение Visual Studio генерирует еще более приятные комментарии в формате XML. Теги param и return являются встроенными, тогда как теги summary остаются в отдельных строках. Возможно, это уже соответствует Вашим потребностям.

Answer 3

Вы можете заставить GhostDoc работать, если отключите «Переформатировать встроенные комментарии XML-документа» в настройках «Очистки кода» по умолчанию в категории «C #». Затем в разделе StyleCop отключите правило «1611: параметры элемента должны быть задокументированы» и правило «1618: параметры общего типа должны быть задокументированы». Таким образом, очистка кода не изменит ваши комментарии GhostDoc. Помните, что параметры очистки кода зависят от решения.