Visual Studio XML сводный комментарий в одну строку - PullRequest
Новая
       35

Visual Studio XML сводный комментарий в одну строку

12 голосов
/ 26 ноября 2011

В Visual Studio как изменить стандартный фрагмент сводного комментария XML с трех строк на одну строку?

В настоящее время он предоставляет этот фрагмент, когда я набираю ///: 

/// <summary>
/// 
/// </summary>

Я хотел бы этот короткий фрагмент: 

///<summary></summary>

Мои резюме часто являются краткими, а лишние 2 строки не нужны.

Существует ли параметр конфигурации для этого или некоторого настраиваемого кода / пользовательского дополнения, чтобы исправить это.

Ответы [ 3 ]

4 голосов
/ 22 августа 2013

Это более старый вопрос, но мне понравилось предложение Джейсона Уильямса создать фрагмент для этого, так что я сделал. Не очень сложно, но копировать и вставлять еще проще:) 

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
  <CodeSnippet Format="1.0.0">
    <Header>
      <Title>Single line summary</Title>
      <Shortcut>summary</Shortcut>
    </Header>
    <Snippet>
      <Code Language="csharp">
        <![CDATA[/// <summary>$end$</summary>]]>
      </Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>

Вы можете изменить ярлык путем (вероятно, очевидно) изменения значения <Shortcut>.

Вставьте это в новый файл с именем SingleLineSummary.snippet и сохраните его в папке %USERPROFILE%\Documents\Visual Studio 2012\Code Snippets\Visual C#\My Code Snippets (измените, чтобы соответствовать вашей версии Windows и Visual Studio).

Если вы не знакомы с фрагментами, для этого просто поместите курсор над методом / свойством / etc, начните вводить summary, а затем пару раз нажмите TAB.

3 голосов
/ 11 февраля 2016

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

Тем временем идея с фрагментами хорошая, но поведение немногоразные.Если вы хотите сохранить то же поведение и если вы хотите приобрести стороннее дополнение, то в SubMain есть продукт под названием «GhostDoc Pro», который, приложив немного усилий, сделает это за вас.(Обратите внимание, что у них есть бесплатная, не «про» версия, «GhostDoc», но я не думаю, что она будет работать.)

Если вы хотите пойти по этому пути, вот как это работает.

  1. После установки GhostDoc Pro перейдите в меню «Инструменты».Вверху появится новое всплывающее подменю «GhostDoc Pro».
  2. Перейдите в Инструменты -> GhostDoc Pro -> Параметры -> Правила

  3. Вам нужно будет отредактироватьшаблон T4 для КАЖДОГО типа, на который вы хотите, чтобы это вступило в силу.

    1. Нажмите на правило и затем нажмите «Изменить»

    2. В верхней части измените 

      /// <summary>
///<# GenerateSummaryText(); #>
/// </summary>

      только на 

      /// <summary><# GenerateSummaryText(); #></summary>
    3. В методе GenerateSummaryText измените каждый this.WriteLine на this.Write
    4. Нажмите OK, чтобы сохранить, перейдите к следующему шаблону.

  4. Перед закрытием страницы параметров перейдите в раздел «Общие» (из «Правил») и отметьте «Выделить автоматически сгенерированную сводку».когда документ это ".Это приведет к тому, что вновь вставленный автотекст будет выделен из списка, поэтому, если он вам не нравится, вы можете просто начать печатать.Конечно, если вы предпочитаете, чтобы текст просто не генерировался, вы тоже можете это сделать, но вам придется немного изменить шаблоны T4.В частности, вам нужно, чтобы GenerateSummaryText просто использовал одну строку, 

     this.Write(Context.ExecMacro("$(End)"));

    Это не приведет к генерации текста, но поместит курсор между тегами 2 <summary>.

Примечание:

Если кто-нибудь знает, как получить ReSharper или другие дополнительные инструменты для этого, мне было бы интересно увидеть это решение.а также - если только по любопытству.

2 голосов
/ 04 декабря 2011

Вы можете вручную отформатировать комментарий так, как вам нравится, при условии, что он остается действительным xml.

Самый дешевый подход может заключаться в отключении автоматического создания комментария в Visual Studio (Инструменты> Параметры> Текст).Editor> C #> Создать комментарии XML-документации для ///) и использовать фрагмент кода для вставки /// <summary></summary>.

Если вы хотите, чтобы формат по умолчанию был одной строкой, и / или помогите сохранить форматМожет быть интересен и мой читательский документ Документация Atomineer Pro .Среди множества вариантов один - использовать компактный однострочный формат для любого комментария, достаточно короткого, чтобы поместиться в одну строку.Он специально разработан для этого, поэтому он может работать лучше для ваших нужд.

Последнее предложение заключается в том, что есть несколько других надстроек (Resharper и т. Д.), Которые могут генерировать простые шаблонные xml doc-комментарии -Я считаю, что некоторые из этих надстроек могут быть настроены для использования определенного фрагмента текста.Если у вас уже есть такое дополнение, возможно, ваше может быть скорректировано для предоставления требуемого однострочного формата, в несколько более продвинутой манере, чем это возможно при базовой настройке Visual Studio, предложенной выше.

...