如何将 SonarQube 规则描述指定为 markdown/html 资源文件而不是使用注释?

How to specify SonarQube rule description as a markdown/html resource file instead of using annotation?

我有我的自定义规则,假设使用 AEM-1 键。因此,当它完成时 here,我用一些简单的 html 内容制作了我的 AEM-1.html 资源文件,它不会被 SonarQube 5.1 拾取。它拒绝启动,因为没有为规则提供描述。

我尝试了不同的包名称,尝试在源代码中寻找约定等。缺少什么?有这方面的文档吗?

命名约定是org/sonar/l10n/{插件密钥}_{语言}/规则/{存储库密钥}/{规则密钥}。html。

当时规则描述支持本地化,http://docs.sonarqube.org/display/DEV/Internationalization 中对此进行了记录。自版本 4.2 以来不再是这种情况,但这些 HTML 捆绑包仍然受支持。

从 4.3 版本开始的正确方法是使用低级 API org.sonar.api.server.rule.RulesDefinition。它允许您在其上实现任何类型的层(xml、json、注释等)。