GhostDoc“Document this”不适用于带属性的方法

时间:2018-05-02 11:55:34

标签: xml-comments ghostdoc

我正在使用GhostDoc和Visual Studio 2017。

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

public string Foo() { ... }

我通常可以使用GhostDocs“Document this”为相关方法生成XML注释。

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

[NotNull]
public string Foo() { ... }

GhostDoc 无法自动记录该方法。这是为什么?由于我的所有方法都被注释,因此无法使用GhostDoc不太舒服。

  • GhostDoc有没有办法记录带属性的方法?

顺便说一句:我尝试通过在属性和方法之间插入/// 来手动添加注释,从而产生

  

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

错误。

enter image description here

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

1 个答案:

答案 0 :(得分:1)

来自SubMain的Serge来了。

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

您能否向我们发送GhostDoc日志文件以进行故障排除?您将在\ SubMain \ GhostDoc {Edition}中找到VSxxxx * .log的日志文件

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

如果您包含非常有用的生产版本和版本。

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

谢谢!