Question

我的评论如下：

/// <summary>
///     Creates a filename given the end date provided
/// </summary
/// <returns></returns>
public static string GetFileName(DateTime date, string filePath) {
        var ret = string.Format("file_{0}[{1}].txt", date.ToString("yyyyMMdd"), date.ToString("HHmm"));
        return Path.Combine(filePath, ret);
    }

当我输入///.

时，Visual Studio会自动创建上面的注释

是否有重新生成上述评论并添加我最近新添加的参数？

我知道我可以通过输入///删除并重做它，它会自动生成适当的参数。有不同的方式吗？

Answer 1

GhostDoc是一个Visual Studio扩展，可以帮助生成这些类型的文档。

我也听过关于Resharper的好消息，但没有亲自使用它。

否则，我通常只是重新键入///，如果它发生了变化。

Answer 2

首先，您可以通过在摘要中添加必要的<param>项来手动执行此操作。

/// <summary>
///     Creates a filename given the end date provided
/// </summary>
/// <param name="date">It is a date</param>
/// <param name="filePath">Valid path</param>
/// <returns></returns>
public static string GetFileName(DateTime date, string filePath) {
   var ret = string.Format("file_{0}[{1}].txt", date.ToString("yyyyMMdd"), date.ToString("HHmm"));
    return Path.Combine(filePath, ret);
}

第二个（对于懒人），您可以删除此评论并再次输入“///”：）

Answer 3

GhostDoc是TheMi7ch建议的工具。您可以使用“工具”菜单下的“Visual Studio扩展和更新”下载它。

Answer 4

Intellisense对我很有用：

转到</summary>行的末尾并按Enter键 - VS将在其上生成一个包含///的新行。
输入<p，Intellisense会给你一些很好的建议。

在某些设置中，我看到Intellisense只列出了所有丢失的param标签，您可以通过这种方式逐个添加它们。在其他设置上，它只会给你<param name=""></param>并将插入点放在引号之间，以便填写参数名称。我猜你得到的行为取决于你是否安装了Resharper。

生成后如何在Visual Studio中的方法注释中添加参数？

4 个答案: