方法签名更改后的 C# 文档更新

Question

在 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)
{
}

编辑：我正在为此任务寻找一些自动化解决方案。

Answer 1

也看看 GhostDoc. It's on the visual studio marketplace。

我使用的是免费版本，它将为您记录方法（并更新它们）。只需将光标放在方法定义上，然后按 CTRL + SHIFT + D（默认情况下）即可更新 method/class 文档。

下面是更新您的示例后的结果：

/// <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)
{
}

方法签名更改后的 C# 文档更新

C# documentation update after method signature change

c#

documentation