测试查询帮助文件

确保通过将其预览为 Markdown 来验证你的 CodeQL 查询帮助文件是否有效。

谁可以使用此功能？

CodeQL 可用于以下存储库类型：

在本文中

先决条件

  • 查询帮助 （.qhelp） 文件必须附带具有相同基名称的查询 （.ql） 文件。
  • 查询帮助文件应遵循查询帮助文档的标准结构和样式。 有关详细信息，请参阅 CodeQL 存储库中的查询帮助样式指南。

预览您的查询帮助文档

  1. 若要将查询帮助文件呈现为 Markdown，请运行以下命令：

    Shell
    codeql generate query-help <qhelp|query|dir|suite> --format=markdown [--output=<dir|file>]

    有关可用于此命令的选项的信息，请参阅 生成查询帮助。

  2. 如果收到任何警告消息，请查看并修复它们，然后重新运行命令。 默认情况下，CodeQL CLI 将在以下情况下显示警告消息：

    • 任何查询帮助都无效
    • 命令中指定的任何 .qhelp 文件都不具有与随附 .ql 文件相同的基名称
    • 命令中指定的任何 .ql 文件都不具有与随附 .qhelp 文件相同的基名称

  3. 查看输出目录、文件或终端中呈现的 Markdown，检查文件是否按预期显示。

延伸阅读

  •         [查询帮助文件](https://codeql.github.com/docs/writing-codeql-queries/query-help-files/#query-help-files)

  •         [AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual/generate-query-help)