Testen von Abfragehilfedateien

Stellen Sie sicher, dass Ihre CodeQL Abfragehilfedateien gültig sind, indem Sie sie als Markdown in der Vorschau anzeigen.

Wer kann dieses Feature verwenden?

CodeQL ist für die folgenden Repositorytypen verfügbar:

In diesem Artikel

Voraussetzungen

  • Die Abfragehilfedateien (.qhelp) müssen begleitende Abfragedateien (.ql) mit identischen Basisnamen haben.
  • Die Abfragehilfedateien sollten der Standardstruktur und dem Standardstil für die Hilfedokumentation für Abfragen entsprechen. Weitere Informationen findest du im Leitfaden zur Abfragehilfe im CodeQL-Repository.

Vorschau Ihrer Abfrage-Hilfedateien

  1. Führen Sie den folgenden Befehl aus, um Die Abfragehilfedateien als Markdown zu rendern:

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

    Informationen zu den für diesen Befehl verfügbaren Optionen finden Sie unter Abfragehilfe generieren.

  2. Wenn Sie Warnmeldungen erhalten, überprüfen und korrigieren Sie sie, und führen Sie den Befehl erneut aus. Standardmäßig gibt die CodeQL CLI eine Warnmeldung aus, wenn Folgendes zutrifft:

    • Eine der Abfragehilfen ist ungültig.
    • Alle im Befehl angegebenen .qhelp-Dateien haben nicht den gleichen Basisnamen wie die zugehörige .ql-Datei.
    • Alle im Befehl angegebenen .ql-Dateien haben nicht den gleichen Basisnamen wie die zugehörige .qhelp-Datei.

  3. Überprüfen Sie das gerenderte Markdown in Ihrem Ausgabeverzeichnis, Ihrer Datei oder Ihrem Terminal, um zu überprüfen, ob Ihre Dateien wie erwartet angezeigt werden.

Weiterführende Lektüre

  •         [Abfragehilfedateien](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)