Ghostdoc не пытается генерировать возвращаемую информацию - PullRequest
Новая
       31

Ghostdoc не пытается генерировать возвращаемую информацию

0 голосов
/ 28 января 2019

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

/// <summary>
/// Gets the departure date.
/// </summary>
/// <returns></returns>
private DateTime GetDepartureDate()
{
    // TODO:
}

Я ожидал бы, что он заполнит информацию о возврате следующим образом: 

/// <summary>
/// Gets the departure date.
/// </summary>
/// <returns>The departure date.</returns>
private DateTime GetDepartureDate()
{
    // TODO:
}

Я видел это , но этодовольно стар, и, честно говоря, я не совсем понимаю.Любые идеи?

Очевидно, что это никогда не будет идеально, но все лучше, чем ничего.

1 Ответ

0 голосов
/ 07 марта 2019

По умолчанию Ghostdoc не пытается предоставить какой-либо текст для возвращаемых типов.Тем не менее, вы можете настроить правило, чтобы сделать это, как предложено в ссылке в вопросе.

Например, чтобы установить правило, которое добавляет описание возврата к любому методу с именем, начинающимся с 'Get ... 'и используя оставшуюся часть имени метода для текста (как предложено в вопросе):

  1. В Visual Studio выберите Инструменты> Ghostdoc> Параметры
  2. Выбрать Rules под GhostDoc в дереве
  3. Выберите Methods «папку» в правом списке правил (может потребоваться прокрутить список)

Добавить новыйПравило для соответствия методов, начинающихся с 'Get ...':

Нажмите Add... и OK, чтобы добавить новое правило «Настраиваемое совпадение» Измените имя на что-то вроде:

Методы «Получить» сопоставления

Нажмите на ссылку <any> после method name, чтобы установить условие

Выберите starts with, введите

Получить

, за которым следует пробел, в текстовом поле и нажмите OK

Теперь, чтобы установить текст шаблона возврата:

В сетке нажмите кнопку с многоточием ... рядом с <returns>

Тип

, а затемпробел, в поле «Текст шаблона»

Разверните MethodName> Words, выберите ExceptFirst, нажмите Insert и OK

Сводный текст по умолчанию переопределяется новым правилом, поэтому добавим что-то разумное для нашего нового правила:

Вернувшись в сетку, нажмите кнопку ... рядом с <summary>

Тип

Получает

, за которым следуетчерез пробел в текстовом поле Шаблон

Разверните MethodName> Words, выберите ExceptFirst, нажмите Insert и OK Нажмите OKчтобы завершить настройку правила

Убедитесь, что правило расположено ниже существующего правила int GetHashCode(), так что последнее будет иметь приоритет в этом особом случае.Нажмите кнопку ОК, чтобы закрыть диалоговое окно «Параметры», и вы готовы опробовать новое правило.

...