GhostDoc“记录此”不适用于具有属性的方法

Posted 2023-03-31

【中文标题】GhostDoc“记录此”不适用于具有属性的方法

【英文标题】：GhostDoc "Document this" not working for method with attribute

【发布时间】：2018-10-12 12:45:28

【问题描述】：

我正在使用 GhostDoc 和 Visual Studio 2017。

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

public string Foo()  ... 

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

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

[NotNull]
public string Foo()  ... 

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

GhostDoc 有什么方法可以用属性记录方法？

---

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

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

错误。

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

【参考方案1】：

来自 SubMain 的 Serge 来了。

我们试图重现您报告的问题，GhostDoc 生成的文档很好。

能否将 GhostDoc 日志文件发送给我们以进行故障排除？您将在 \SubMain\GhostDoc Edition 中找到 Vsxxx*.log 的日志文件

请将日志发送到 submain dot com 的支持处。

如果您包括生产版本和版本将非常有帮助。

我们期待与您合作解决您遇到的问题！

谢谢！

【讨论】：

很奇怪，当我今天想再次重现这个问题时，我做不到。可能是因为 VS 更新...不过，感谢您的回答和您的帮助。

我的荣幸！我很高兴 GhostDoc 再次为您工作！