问题标签 [ghostdoc]

一年前，我在 Visual Studio 2015 中使用了 Ghostdoc Free，并且非常喜欢它的功能，并决定购买它。我现在必须使用 Visual Studio 2012 并注意到类的注释不如以前好。

它现在只是说：

/// The ClassName class.

而在此之前，它会区分实现接口的类，例如：

/// Implements the <see cref="IInterfaceName"

我查看了规则，但我不确定如何提取接口的名称。我现在有这个：

结果是：

/// Provides a class that implements a class name这只是取类名并将其拆分。这/// Implementation of IInterfaceName有点生硬（在多个接口的情况下）

那里有任何可以在此处插入接口名称的示例吗？

我正在使用 GhostDoc 和 Visual Studio 2017。

现在，如果我有这样的方法

我通常可以使用 GhostDocs“记录这个”来为相关方法生成 XML 注释。

但是，如果该方法应用了任何属性，例如

GhostDoc无法自动记录该方法。这是为什么？由于我的所有方法都已注释，因此无法使用 GhostDoc 并不是很舒服。

• GhostDoc 有什么方法可以记录带有属性的方法？

顺便说一句：我尝试通过在属性和方法/// 之间插入来手动添加注释，这会产生

XML 注释未放在有效的语言元素上

错误。

但是，如果我在属性/// 之前插入，我不会收到错误消息。我觉得即使在方法和属性/// 之间添加注释，注释也会应用于方法，因此应该放在有效的语言元素上，不是吗？

我使用 Ghost doc 为方法生成了 xml 注释

并且找不到任何意义或文档。我宁愿生成像

无论如何，除了自己编辑评论（而不是编辑某些模板或为占位符提供价值）之外，我还能以某种方式使其更易于理解吗？

我不想记录<value>C# 属性的元素。但是，GhostDoc 被配置为完全做到这一点。我认为通过访问配置屏幕并删除元素很容易将其删除。但是没有按钮或右键单击上下文菜单可以做到这一点。在这里按下DEL也不起作用。有什么建议或想法吗？

我注意到 Ghostdoc 似乎从未尝试生成退货文档。给定这样的方法：

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

我看过这个，但这已经很老了，老实说，我不太明白。有任何想法吗？

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

我正在使用 Visual Studio 2017 Community Edition V15.8.4 和 Marketplace 中提供的最新 Ghostdoc 版本（内部版本 2018.1.18330）。

自上次更新以来，Ghostdoc 不再识别任何分配的快捷方式。每当分配除 Ctrl+Shift+D 以外的任何快捷方式时，在“记录此”中 Ghostdoc 会说“Ghostdoc 注意到您没有与记录此关联的快捷方式。是否要重新分配 Ctrl+Shift+D 快捷键？'。

如何分配快捷方式并不重要（工具 => 选项 => 键盘或 Ghostdoc 重新分配快捷方式）。如果我使用菜单而不是快捷方式来记录某些内容，也会弹出错误。

尝试过的快捷方式未在其他任何地方使用，如果我分配 Ghostdoc 建议的快捷方式之一，我也会收到错误消息。

如果我为 VS 2017 卸载 Ghostdoc，仍然存在无法卸载的 Ghostdoc 社区。禁用它没有任何区别并尝试仅使用此版本记录某些内容，它总是说“无法执行操作，VS 仍在加载项目”，即使在项目明显完全加载后也是如此。

如果我分配快捷方式并取消“...重新分配 Ctrl+Shift+D 快捷方式？” 弹出窗口，使用新快捷方式进行评论实际上有效。

有谁知道为什么会发生这种情况以及如何解决。如果没有，是否可以在某处手动添加快捷方式，例如设置文件？

我在 Visual Studio 2017 上使用上述文档工具。

我可以访问 GhostDoc 选项 > 规则 > 属性模板并自定义代码。我有一个像这样的财产；

我想达到“必需”和“显示名称”属性并总结使用它们。有没有办法实现它？

谢谢你。

所以我有 GhostDoc Pro 并自动记录了一个项目。伟大的。结果是，正如它在 C# 文档中所说的那样，与代码相比，将它们放在一起很冗长。因此，我想为文档使用包含标签和一个单独的文件，以减少我的类的文档负担。

所有类都是自动记录的，但文档进入类包含文件，如下所示：

和另一个班级

是否有这样做的功能，还是我必须手动移动每个文档标签？我希望每个类都有自己的包含文件。

我正在寻找配置 GhostDoc 以使“值”在单行上，而“摘要”始终在多行上。

有一个“在...下保持单行”选项，但它适用于“摘要”和“值”。

方法的行为表明这是可能的。默认文档将“摘要”放在多行上，但每个“参数”放在一行上。

这是我想要的与默认/选项显示的示例：