Ghostdoc 不会尝试生成返回信息

Posted 2023-03-31

【中文标题】Ghostdoc 不会尝试生成返回信息

【英文标题】：Ghostdoc doesn't attempt to generate return information

【发布时间】：2019-06-21 09:14:53

【问题描述】：

我注意到 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:

我见过this，但这已经很老了，老实说，我不太明白。有什么想法吗？

显然它永远不会完美，但有总比没有好。

【问题讨论】：

嗨 Robbie，你使用的是什么版本的 ghostdoc？

@Ian 我们在 2018.1.18330（社区）

【参考方案1】：

默认情况下，Ghostdoc 不会尝试为返回类型提供任何文本。但是，您可以按照问题链接中的建议设置规则来执行此操作。

例如，要设置一个规则，将返回描述添加到名称以“Get...”开头的任何方法，并使用方法名称的其余部分作为文本（如问题中所建议的那样）：

在 Visual Studio 中，转到工具 > Ghostdoc > 选项 在树中的GhostDoc 下选择Rules 在右侧规则列表中选择Methods“文件夹”（您可能需要滚动列表）

添加新规则以匹配以“Get...”开头的方法：

点击 Add... 和 OK 添加新的“自定义匹配”规则 将名称更改为：

匹配“获取”方法

点击method name后面的<any>链接设置条件

选择starts with，输入

获取

后跟一个空格，在文本框中点击OK

现在，设置“返回”模板文本：

在网格中，单击<returns> 旁边的省略号按钮...

键入

后跟一个空格，在“模板文本”框中

展开MethodName > Words，选择ExceptFirst，点击Insert和OK

默认摘要文本被新规则覆盖，因此为我们的新规则添加一些有意义的内容：

返回网格，单击<summary> 旁边的... 按钮

键入

获取

后跟一个空格，在模板文本框中

展开MethodName > Words，选择ExceptFirst，点击Insert和OK 点击OK完成规则设置

确保该规则位于现有 int GetHashCode() 规则的下方，以便在该特殊情况下后者优先。单击“确定”关闭“选项”对话框，您就可以尝试新规则了。