# 关于适用于 VS Code 的 CodeQL

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

## 关于适用于 CodeQL 的 Visual Studio Code

可以对从源代码生成的数据库运行 CodeQL 查询，以便查找代码库中的错误和安全漏洞。 有关 CodeQL code scanning 的更多信息，请参阅 [关于使用 CodeQL 进行代码扫描](/zh/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql)。

通过适用于 CodeQL 的 Visual Studio Code 扩展，可以执行以下操作：

* 编写自定义 CodeQL 查询和支持库
* 直接查看并使用大型开源 [`github/codeql`](https://github.com/github/codeql) 存储库中的 CodeQL 安全查询。
* 对一个或多个 CodeQL 数据库运行查询
* 通过程序跟踪数据流，突出显示存在潜在安全漏洞的区域。
* 查看、创建和编辑所有类型的查询或库的 CodeQL 包，你可以使用这些包，也可以发布包与他人共享。
* 运行 CodeQL 查询的单元测试。
* 使用专用编辑器来查看、创建和编辑 CodeQL 模型包，这些包用于扩展标准 CodeQL 分析。

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

### IntelliSense

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

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

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

还可以使用 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
的更多信息，请参阅 VS Code 文档中的“用户界面”[](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette)。

## 数据和遥测

如果明确选择允许 GitHub 收集使用情况数据和指标，GitHub 将执行此操作，以帮助核心开发人员改进适用于 CodeQL 的 Visual Studio Code 扩展。 有关详细信息，请参阅“[Visual Studio Code 的 CodeQL 中的遥测](/zh/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/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)\*\*\*\*。

有关如何使用 GitHub Enterprise 免费试用 GitHub Advanced Security 的信息，请参阅 GitHub Enterprise Cloud 文档中的 [设置 GitHub Enterprise Cloud 试用版](/zh/enterprise-cloud@latest/admin/overview/setting-up-a-trial-of-github-enterprise-cloud) 和 [安装 GitHub Advanced Security 试用版](/zh/enterprise-cloud@latest/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/setting-up-a-trial-of-github-advanced-security#setting-up-your-trial-of-github-advanced-security)。

## 后续步骤

要了解如何安装适用于 CodeQL 的 Visual Studio Code 扩展，请参阅 [安装适用于 Visual Studio Code 的 CodeQL](/zh/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/installing-codeql-for-vs-code)。