2013-04-18 1 views
3

Я использую GhostDoc для создания комментариев к XML, и я очень доволен форматом. Я использую следующий формат (C#)R #: Остановите это, коснувшись комментариев ghostdoc XML на очистку кода?

/// <summary> 
    /// Creates new client. 
    /// </summary> 
    /// <param name="uri">The URI.</param> 
    /// <param name="param">The param.</param> 
    /// <returns></returns> 

Используя код очистки от R # 7.1.1 это переформатирует мои комментарии XML, он даже вставляет новые комментарии XML там, где не хватало, его очень раздражает. Есть ли способ остановить это.

Я создал свои собственные профили для очистки кода и отключил все (даже настройки стиля), и я делаю очистку кода, и, конечно же, он хочет переформатировать мои комментарии xml и разместить новые, где они отсутствовали.

Кто-нибудь знает, как обойти это?

Благодаря

ответ

2

Скорее всего, вы делаете что-то неправильно или вы попали ошибка или в ReSharper или в StyleCop. Вы должны:

  1. Попробуйте полностью отключить StyleCop.
  2. Двойной проверить, что вы отключили C# | Встраиваемый XML-документ Reformat в вашем настраиваемом профиле.
  3. Двойная проверка того, что вы действительно выбираете этот настраиваемый профиль при вызове очистки кода.
  4. Создайте образец решения, в котором проблема может быть воспроизведена, и обратитесь в службу поддержки ReSharper. См http://www.jetbrains.com/support/resharper/
+0

Что касается "Попробуйте полностью отключить StyleCop", у вас есть какие-либо предложения, помимо того, что пытался сделать ОП? [Связанный поиск] (http://www.bing.com/search?q=turn+off+StyleCop&go=&qs=n&form=QBRE&pq=turn+off+stylecop&sc=3-17&sp=-1&sk=) заставляет меня думать отключение всех правил StyleCop (это то, что я использую для описания OP), сделает это. Может быть, удалять StyleCop, чтобы помочь в процессе устранения, было бы лучше? В противном случае мне приходит в голову, что, конечно, правильный уровень настроек StyleCop (т. Е. Все) должен быть отключен. – J0e3gan

+1

@ J0e3gan Я, к сожалению, не специалист по StyleCop, но я имел дело с определенными «странными ошибками ReSharper», которые были фактически вызваны StyleCop. Дело не в том, что StyleCop плох, но каждый может сделать ошибку, и мне нужно быть уверенным, что это на самом деле моя ошибка. Вот почему правило номер один, когда мы имеем дело с ошибками форматирования для меня, - попросить пользователя временно избавиться от StyleCop полностью. Недостаточно отключить правила. Возможно, есть возможность временно выгрузить StyleCop (для ReSharper вы можете перейти в Инструменты -> Параметры -> ReSharper -> Suspend), или, возможно, OP необходимо временно удалить StyleCop. –

+1

Понял - полностью имеет смысл. Я тоже не специалист по StyleCop, но я нашел изменение файла 'csproj' для его отключения в заданном проекте - полезен для такого рода устранения неполадок и других ситуаций, которые требуют отключения StyleCop на уровне проекта. Старая MSKB [статья] (http://support.microsoft.com/kb/969475?wa=wsignin1.0) объясняет, что добавление ' false' в раздел глобальной конфигурации файла проекта будет отключите StyleCop для проекта. Я проверил его (используя StyleCop 4.7), и он отлично работает. – J0e3gan

0

ReSharper> Функции> StyleCop

Выключить заголовков> Вставить текст в документации и файлов заголовков

1

У меня была аналогичная проблема. Я использовал GhostDoc и R # Code Cleanup вертел этот

/// <summary> 
/// Defines the entry point of the application. 
/// </summary> 
/// <param name="args">The arguments.</param> 

в этом

/// <summary> 
/// Defines the entry point of the application. 
/// </summary> 
/// <param name="args"> 
/// The arguments. 
/// </param> 

Это было бешенство, потому что я был Reformat embedded XML doc comments снят. Я, наконец, нашел оскорбительную настройку в ReSharper->Options->Code Cleanup->StyleCop->1611: Element Parameters Must Be Documented.. Я снял флажок, и он прекратил прикручивать мое форматирование.

Вы должны следовать аналогичному подходу со своими собственными проблемами, заменяя «Параметры» любой вашей проблемой.

+0

Я обнаружил, что это сделали SA1611, SA1615 и SA1617. – Stephen

0

В качестве другого варианта,

Под Resharper> Функции> Инструменты> StyleCop> Заголовки

выберите "Использовать отдельные строки для декларирования заголовков"

Смежные вопросы