クエリヘルプファイルのテスト

[前提条件]

クエリヘルプ (.qhelp) ファイルには、同じベース名を持つ付随するクエリ (.ql) ファイルが必要です。
クエリヘルプファイルは、クエリヘルプドキュメントの標準の構造とスタイルに従う必要があります。詳しくは、CodeQL リポジトリの「クエリヘルプスタイルガイド」を参照してください。

クエリヘルプファイルを Markdown としてレンダリングするには、次のコマンドを実行します。
Shell
```
codeql generate query-help <qhelp|query|dir|suite> --format=markdown [--output=<dir|file>]
```
```
codeql generate query-help <qhelp|query|dir|suite> --format=markdown [--output=<dir|file>]
```
このコマンドで使用できるオプションについては、クエリヘルプを生成するを参照してください。
警告メッセージが表示された場合は、それらを確認して修正してから、コマンドを再実行します。既定では、CodeQL CLI では次の場合に警告メッセージが出力されます。
- クエリヘルプのいずれかが無効です
- コマンドで指定された .qhelp ファイルに、添付の .ql ファイルと同じベース名がない
- コマンドで指定された .ql ファイルに、添付の .qhelp ファイルと同じベース名がない
出力ディレクトリ、ファイル、またはターミナルでレンダリングされた 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)