Como testar arquivos de ajuda de consulta

Pré-requisitos

Os arquivos de ajuda de consulta (.qhelp) devem ter arquivos de consulta (.ql) com nomes de base idênticos.
Os arquivos de ajuda de consulta devem seguir a estrutura e o estilo padrão para a documentação da ajuda de consulta. Para obter mais informações, confira o Guia de estilo de ajuda de consulta no repositório do CodeQL.

Para renderizar os arquivos de ajuda de consulta como Markdown, execute o seguinte comando:
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>]
```
Para obter informações sobre as opções disponíveis para este comando, consulte gerar consulta-ajuda.
Se você receber mensagens de aviso, revise-as e corrija-as, então reexecute o comando. Por padrão, a CodeQL CLI imprimirá uma mensagem de aviso se:
- Qualquer uma das ajudas de consulta é inválida
- Algum dos arquivos .qhelp especificados no comando não tiver o mesmo nome base que um arquivo .ql que o acompanhe
- Algum dos arquivos .ql especificados no comando não tiver o mesmo nome base que um arquivo .qhelp que o acompanhe
Examine o Markdown renderizado em seu diretório de saída, arquivo ou terminal para verificar se os arquivos aparecem conforme o esperado.

        [Arquivos de ajuda para consulta](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)