GhostDoc“Document this”对带属性方法失效问题咨询（VS2017）

我之前也碰到过类似的情况，结合实际使用经验给你分析下原因和可行的解决办法：

问题原因 #

1. 版本兼容性问题：你使用的GhostDoc版本可能对VS2017的属性解析支持不够完善，尤其是像[NotNull]这类第三方（比如JetBrains系列）或自定义属性，旧版本的GhostDoc在识别方法定义时会被这些属性干扰，无法正确定位方法主体，从而中断注释生成流程。
2. 属性未被纳入识别规则：GhostDoc默认的解析规则里可能没有包含[NotNull]这类属性，它会把这些属性当成方法定义的异常部分处理，导致无法触发正常的注释生成逻辑。

解决办法 #

• 升级GhostDoc到兼容VS2017的最新版本：GhostDoc后续更新的版本通常会修复这类解析兼容问题，你可以找到支持Visual Studio 2017的最新GhostDoc版本重新安装，很多时候升级后就能直接解决问题。
• 配置GhostDoc忽略特定属性：打开GhostDoc的设置面板，找到「Advanced」或者「Custom Rules」相关选项，把[NotNull]这类属性添加到「Ignored Attributes」列表中。这样GhostDoc在解析方法时会自动跳过这些属性，专注于方法本身的注释生成。
• 自定义注释模板：如果升级和忽略属性都没效果，可以尝试自定义GhostDoc的注释模板。在模板中补充对带属性方法的兼容逻辑，确保不管方法前有没有属性，都能生成标准的XML注释结构。
• 临时替代方案：如果暂时没法彻底解决，你可以先临时注释掉方法上的[NotNull]属性，用GhostDoc生成注释后再把属性恢复；或者先使用VS自带的///快捷键生成基础XML注释框架，再用GhostDoc的功能补充完善注释内容。

内容的提问来源于stack exchange，提问作者Thomas Flinkow