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

时间:2019-03-23 07:03:56

标签: c# documentation

在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 个答案:

答案 0 :(得分:1)

看看GhostDoc。它也在visual studio marketplace上。

我使用了免费版本,它将为您记录方法(并更新方法)。只需将光标放在方法定义上,然后按using UnityEngine; public class Player : MonoBehaviour { private void OnTriggerEnter(Collider other) { if (other.tag == "Food") { Destroy(other.gameObject); FindObjectOfType<SpawnManager>().SpawnFood(); } } }``` (默认情况下)即可更新方法/类文档。

下面是更新示例后的结果:

CTRL + SHIFT + D