쿼리 도움말 파일 테스트하기

사전 요구 사항

쿼리 도움말(.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)