# 适用于 VS Code 的 CodeQL

您可以使用 CodeQL 扩展在 Visual Studio Code 中编写、运行和测试 CodeQL 查询。

## 关于 CodeQL 的 Visual Studio Code

可以对从源代码生成的数据库运行 CodeQL 查询，以便查找代码库中的错误和安全漏洞。 有关 CodeQLcode scanning 的详细信息，请参阅 [使用 CodeQL 扫描代码](/zh/enterprise-server@3.22/code-security/concepts/code-scanning/codeql/codeql-code-scanning)。

使用适用于 CodeQL 的 Visual Studio Code 扩展，您可以：

* 编写自定义 CodeQL 查询和支持库。
* 直接从大型开源CodeQL存储库查看和使用`github/codeql`安全查询。
* 对一个或多个 CodeQL 数据库运行查询。
* 通过程序跟踪数据流，突出显示存在潜在安全漏洞的区域。
* 查看、创建和编辑各种类型的 CodeQL 查询包或库包，您可以使用它们，或发布它们与他人共享。
* 为 CodeQL 查询运行单元测试。
* 使用专用编辑器查看、创建和编辑 CodeQL 模型包，用于扩展标准 CodeQL 分析。

CodeQL 扩展的 Visual Studio Code 还为 CodeQL 添加了一个 VS Code 侧边栏视图。 这包括本地 CodeQL 数据库列表、当前会话中运行的查询概述以及用于大规模分析的变体分析视图。

### IntelliSense

该扩展为你在 `.ql` 编辑器中打开的查询文件（扩展名为 `.qll`）和库文件（扩展名为 VS Code）提供标准的 IntelliSense 功能。 这些包括：

* 语法突出显示
* 右键单击选项（如**转到定义**）
* 自动完成建议
* 悬停信息

有关 VS Code 中 IntelliSense 的详细信息，请参阅 [](https://code.visualstudio.com/docs/editor/intellisense) 文档中的 Visual Studio Code。

还可以使用 VS Code\*\*“格式文档”\*\* 命令根据 [CodeQL 样式指南](https://github.com/github/codeql/blob/main/docs/ql-style-guide.md)设置代码的格式。

### VS Code Command Palette

你可以从 CodeQL 运行 Visual Studio Code 扩展的 VS Code Command Palette
的命令。 有关  VS Code Command Palette的详细信息，请参阅文档中的[](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette)VS Code。

## 数据和遥测

如果你明确选择允许 GitHub 这样做，GitHub 将收集使用数据和指标，以帮助核心开发人员改进用于 CodeQL 的 Visual Studio Code 扩展。 有关详细信息，请参阅“[Visual Studio Code 的 CodeQL 中的遥测](/zh/enterprise-server@3.22/code-security/reference/code-scanning/codeql/codeql-for-vs-code/telemetry-in-codeql-for-visual-studio-code)”。

## 关于 GitHub CodeQL 许可证

许可证声明：如果没有 GitHub Code Security 许可证，则通过安装此产品，即表示你同意 [GitHub CodeQL 条款和条件](https://github.com/github/codeql-cli-binaries/blob/main/LICENSE.md)\*\*\*\*。

## 后续步骤

若要了解如何安装 CodeQL for Visual Studio Code 扩展，请参阅 [安装适用于 Visual Studio Code 的 CodeQL](/zh/enterprise-server@3.22/code-security/how-tos/find-and-fix-code-vulnerabilities/scan-from-vs-code/install-codeql-for-vs-code)。