Обновление документации C # после изменения сигнатуры метода - PullRequest
0 голосов
/ 23 марта 2019

В C # я использую /// для документирования методов. Есть ли какой-нибудь возможный способ обновить эту документацию после изменения сигнатуры метода (без потери уже введенной информации)?

Например. У меня уже есть:

/// <summary>
/// Example method for my question.
/// </summary>
/// <param name="userName">User name</param>
public void SomeMethod(string userName)
{
}

Я бы хотел обновить документацию метода после изменения метода на:

public void SomeMethod(string userName, int age)
{
}

Редактировать: я ищу какое-то автоматическое решение для этой задачи.

1 Ответ

1 голос
/ 23 марта 2019

Посмотрите на GhostDoc .Он также на рынке визуальных студий .

Я использовал бесплатную версию, которая будет документировать методы для вас (и обновлять их).Просто поместите курсор на определение метода и нажмите CTRL + SHIFT + D (по умолчанию), чтобы обновить документацию метода / класса.

Ниже приведен результат после обновления вашего примера:

/// <summary>
/// Example method for my question.
/// </summary>
/// <param name="userName">User name</param>
/// <param name="age">The age.</param>
public void SomeMethod(string userName, int age)
{
}
...