Question

我注意到Ghostdoc似乎从未尝试过制作退货文件。给定这样的方法：

<wsdl:types>
<xs:schema>
<xs:import schemaLocation="../Schemas/UWLR_Leerlinggegevens_v2p2.xsd" namespace="http://www.edustandaard.nl/leerresultaten/2/leerlinggegevens"/>
<xs:import schemaLocation="../Schemas/UWLR_Autorisatie_v2p2.xsd" namespace="http://www.edustandaard.nl/leerresultaten/2/autorisatie"/>
</xs:schema>
</wsdl:types>

我希望它会像这样填充退货信息：

/// <summary>
/// Gets the departure date.
/// </summary>
/// <returns></returns>
private DateTime GetDepartureDate()
{
    // TODO:
}

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

很显然，它永远不会是完美的，但是任何事情总比没有好。

Answer 1

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

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

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

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

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

匹配“获取”方法
点击<any>之后的method name链接以设置条件
选择starts with，键入

获取

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

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

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

在“模板文本”框中，紧跟一个空格
展开MethodName> Words，选择ExceptFirst，单击Insert和OK

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

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

获取

在模板文本框中，
后跟空格
展开MethodName> Words，选择ExceptFirst，单击Insert和OK
点击OK完成规则的设置

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

Ghostdoc不会尝试生成返回信息

1 个答案: