vscode 工程中 c_cpp_properties.json文件作用

news/2024/7/8 1:20:58 标签: vscode, json, ide

在 Visual Studio Code（VSCode）开发C或C++项目时，c_cpp_properties.json 文件是一个非常重要的配置文件，主要由微软提供的 C/C++ 扩展（C/C++ extension from Microsoft）使用。它主要用于配置 IntelliSense（代码自动补全）、代码分析、调试等功能。以下是该文件的作用及其各部分的详细说明。

1. 文件位置

通常，c_cpp_properties.json 文件位于 .vscode 目录中，即：

.vscode/
├── c_cpp_properties.json
└── ...

2. 主要作用

  • 配置 IntelliSense：设置编译器路径、头文件搜索路径等信息，使得 VSCode 能够提供高效的代码补全、代码跳转等功能。
  • 配置编译器：指定编译器类型和版本，确保代码分析和调试信息与实际编译器一致。
  • 配置调试和运行环境：为不同的操作系统和环境（如 Windows、Linux、macOS）定制不同的编译和运行配置。

3. 配置文件结构

c_cpp_properties.json 文件结构通常如下：

{
    "configurations": [
        {
            "name": "Win32",
            "includePath": [
                "${workspaceFolder}/**"
            ],
            "defines": [
                "_DEBUG",
                "UNICODE"
            ],
            "compilerPath": "C:/path/to/gcc.exe",
            "cStandard": "c11",
            "cppStandard": "c++17",
            "intelliSenseMode": "gcc-x64"
        }
    ],
    "version": 4
}

接下来是对每个配置项的详细说明：

4. 配置项说明

  • configurations：这是一个配置数组，你可以为不同的平台和环境定义多个配置。
    • name：配置的名称，例如 Win32, Linux, Mac, Custom 等，方便区分和选择。
    • includePath：头文件搜索路径。在解析代码时，VSCode 会在这些路径中搜索头文件。支持使用占位符和环境变量，如 ${workspaceFolder} 表示当前工作区的根目录，或 ${workspaceFolder}/** 表示递归包含所有子目录。
    • defines：定义预处理器宏。例如 _DEBUG, UNICODE, MY_DEFINE=1 等，模拟编译器预定义宏。
    • compilerPath：指定C/C++编译器的路径，VSCode将使用它来获取编译器相关信息。例如，C:/MinGW/bin/gcc.exe 或 /usr/bin/gcc。
    • cStandard：设置C标准，支持的值有 c89, c99, c11, gnu11 等。
    • cppStandard：设置C++标准，支持的值有 c++98, c++11, c++14, c++17, c++20，gnu++11，gnu++17 等。
    • intelliSenseMode：设置 IntelliSense 模式，通常根据编译器和架构选择，常见值包括 gcc-x64, gcc-arm64, msvc-x64, clang-x64, clang-arm64。

5. 示例配置

示例 1：Windows 环境的配置
{
    "configurations": [
        {
            "name": "Win32",
            "includePath": [
                "${workspaceFolder}/include",
                "C:/path/to/external/libs/include"
            ],
            "defines": [
                "_DEBUG",
                "UNICODE",
                "_UNICODE"
            ],
            "compilerPath": "C:/MinGW/bin/gcc.exe",
            "cStandard": "c11",
            "cppStandard": "c++17",
            "intelliSenseMode": "gcc-x64",
            "browse": {
                "path": [
                    "${workspaceFolder}/src",
                    "${workspaceFolder}/include",
                    "C:/path/to/external/libs/src"
                ],
                "limitSymbolsToIncludedHeaders": true,
                "databaseFilename": ""
            }
        }
    ],
    "version": 4
}
示例 2：Linux 环境的配置
{
    "configurations": [
        {
            "name": "Linux",
            "includePath": [
                "${workspaceFolder}/include",
                "/usr/include",
                "/usr/local/include"
            ],
            "defines": [],
            "compilerPath": "/usr/bin/gcc",
            "cStandard": "gnu11",
            "cppStandard": "gnu++17",
            "intelliSenseMode": "gcc-x64",
            "browse": {
                "path": [
                    "${workspaceFolder}/src",
                    "${workspaceFolder}/include",
                    "/usr/include",
                    "/usr/local/include"
                ],
                "limitSymbolsToIncludedHeaders": true,
                "databaseFilename": ""
            }
        }
    ],
    "version": 4
}

6. 配置多个环境

你还可以为多个环境设置不同的配置，并在 VSCode 中自由切换。例如：

{
    "configurations": [
        {
            "name": "Win32",
            "includePath": ["${workspaceFolder}/**"],
            "defines": ["_DEBUG", "UNICODE"],
            "compilerPath": "C:/MinGW/bin/gcc.exe",
            "cStandard": "c11",
            "cppStandard": "c++17",
            "intelliSenseMode": "gcc-x64"
        },
        {
            "name": "Linux",
            "includePath": ["${workspaceFolder}/**", "/usr/include"],
            "defines": [],
            "compilerPath": "/usr/bin/gcc",
            "cStandard": "gnu11",
            "cppStandard": "gnu++17",
            "intelliSenseMode": "gcc-x64"
        }
    ],
    "version": 4
}

7. 总结

c_cpp_properties.json 文件在 VSCode 中对 C/C++ 项目开发起着至关重要的作用，通过配置该文件，你可以：

  • 提供更好的代码补全和代码分析功能。
  • 指定使用的编译器及其版本。
  • 设置头文件搜索路径和预处理器宏定义。
  • 为不同的开发平台定制不同的配置。

合理配置 c_cpp_properties.json 文件，有助于提高开发效率和代码质量。希望以上说明对你理解和使用该文件有所帮助。

8. 关于IntelliSense 模式的使用说明

在 Visual Studio Code（VSCode）中，IntelliSense 是微软为开发者提供的一组丰富的代码辅助功能，包括代码自动补全、参数信息、快速信息和代码片段等。这些功能有助于提高开发效率，减少错误，并使代码更具可读性。

        8.1. IntelliSense 模式

在 c_cpp_properties.json 中，intelliSenseMode 属性用于指定 IntelliSense 的工作模式。这一属性告诉 VSCode 使用哪种编译器和架构来解析和理解代码，以提供更加准确的代码补全、错误报告及其他辅助功能。

        8.2. 支持的 IntelliSense 模式

IntelliSense 模式通常与编译器和目标体系结构相关联。以下是一些常见的 IntelliSense 模式及其含义：

  • msvc-x64：表示使用 Microsoft Visual C++ 编译器（MSVC）进行 64 位架构的解析。
  • msvc-x86：表示使用 MSVC 进行 32 位架构的解析。
  • gcc-x64：表示使用 GNU 编译器集合（GCC）进行 64 位架构的解析。
  • gcc-x86：表示使用 GCC 进行 32 位架构的解析。
  • clang-x64：表示使用 Clang 编译器进行 64 位架构的解析。
  • clang-x86：表示使用 Clang 进行 32 位架构的解析。
  • gcc-arm：表示使用 GCC 进行 ARM 架构的解析。
  • clang-arm：表示使用 Clang 进行 ARM 架构的解析。

        8.3. 如何选择 IntelliSense 模式

选择 IntelliSense 模式时，主要考虑以下几个因素：

  1. 编译器类型：你实际使用的编译器是哪个？MSVC、GCC 还是 Clang？
  2. 目标架构：你的目标操作系统和处理器架构是什么？x86、x64 还是 ARM？
  3. 兼容性：为了确保 IntelliSense 的解析方式与编译器的解析方式一致，选择与你的编译器和目标架构匹配的模式。

        8.4. 示例配置

示例 1：Windows 上使用 MSVC 编译器进行 64 位开发
{
    "configurations": [
        {
            "name": "Win32",
            "includePath": [
                "${workspaceFolder}/**"
            ],
            "defines": [
                "_DEBUG",
                "UNICODE"
            ],
            "compilerPath": "C:/Program Files (x86)/Microsoft Visual Studio/2019/Community/VC/Tools/MSVC/14.24.28314/bin/Hostx64/x64/cl.exe",
            "cStandard": "c11",
            "cppStandard": "c++17",
            "intelliSenseMode": "msvc-x64"
        }
    ],
    "version": 4
}
示例 2：Linux 上使用 GCC 编译器进行 64 位开发
{
    "configurations": [
        {
            "name": "Linux",
            "includePath": [
                "${workspaceFolder}/include",
                "/usr/include",
                "/usr/local/include"
            ],
            "defines": [],
            "compilerPath": "/usr/bin/gcc",
            "cStandard": "gnu11",
            "cppStandard": "gnu++17",
            "intelliSenseMode": "gcc-x64"
        }
    ],
    "version": 4
}

        8.5. 调整 IntelliSense 弹出提示

如果 IntelliSense 的提示信息与你预期不符，可以通过调整 c_cpp_properties.json 中的配置项来进行优化：

  • 确保 includePath 是正确的。
  • 确保 defines 中包含了所有必要的预处理宏。
  • 设置正确的 compilerPath。
  • 选择正确的 intelliSenseMode。

        总结

IntelliSense 模式 是 VSCode 中一个重要的配置项，它决定了代码补全、错误报告等辅助功能的工作方式。通过合理配置 IntelliSense 模式，你可以获得更精准的代码提示和错误检查，从而提升开发效率和代码质量。

        另外，如果还需要进一步的调校和优化 IntelliSense 功能，官方的 C/C++ 扩展文档 是一个很好的参考资源。


http://www.niftyadmin.cn/n/5535937.html

相关文章

2024亚太杯中文赛数学建模选题建议及各题思路来啦！

2024亚太杯中文赛数学建模选题建议及各题思路来啦！

大家好呀，2024年第十四届APMCM亚太地区大学生数学建模竞赛（中文赛项）开始了，来说一下初步的选题建议吧： 首先定下主基调， 本次亚太杯推荐大家选择B题目。C题目难度较高，只建议用过kaiwu的队伍…
阅读更多...
构建大数据生态：Sqoop、Hadoop、IDEA和Maven的完整安装与数据预处理指南【实训Day03】

构建大数据生态：Sqoop、Hadoop、IDEA和Maven的完整安装与数据预处理指南【实训Day03】

一、Sqoop安装 1 上传安装包并解压缩(在hadoop101上) # cd /opt/software 点击xftp上传sqoop的安装文件sqoop-1.4.6.bin__hadoop-2.0.4-alpha.tar.gz # tar -zxvf sqoop-1.4.6.bin__hadoop-2.0.4-alpha.tar.gz -C /opt/module/ # cd /opt/module/ # mv s…
阅读更多...
数据结构 —— 图的遍历

数据结构 —— 图的遍历

数据结构 —— 图的遍历 BFS（广度遍历）一道美团题DFS（深度遍历） 我们今天来看图的遍历，其实都是之前在二叉树中提过的方法，深度和广度遍历。 在这之前，我们先用一个邻接矩阵来表示一个图&#…
阅读更多...
针对某客户报表系统数据库跑批慢进行性能分析及优化

针对某客户报表系统数据库跑批慢进行性能分析及优化

某客户报表系统数据库跑批时间过长，超出源主库较多，故对其进行了分析调优，目前状态如下： 1、业务连接的rac的scanip，因为负载均衡将跑批的连接连接到了多个计算节点导致节点间通讯成本较高，故速率缓慢&…
阅读更多...
【0292】Postgres内核源码之dynahash 查找实现

【0292】Postgres内核源码之dynahash 查找实现

0. 前言 在【0291】Postgres内核之dynahash table 创建 一文中，从内核源码的实现角度讲解了Postgres创建dynahash的底层实现机制；本文将继续从内核角度分析Postgres dynahash find的实现原理。 1. dynahash find
阅读更多...
Airflow: 大数据调度工具详解

Airflow: 大数据调度工具详解

欢迎来到我的博客，很高兴能够在这里和您见面！欢迎订阅相关专栏： 欢迎关注微信公众号：野老杂谈 ⭐️ 全网最全IT互联网公司面试宝典：收集整理全网各大IT互联网公司技术、项目、HR面试真题. ⭐️ AIGC时代的创新与未来&a…
阅读更多...
AR视频技术与EasyDSS流媒体视频管理平台：打造沉浸式视频体验

AR视频技术与EasyDSS流媒体视频管理平台：打造沉浸式视频体验

随着增强现实（AR）技术的飞速发展，其在各个领域的应用日益广泛。这项技术通过实时计算摄影机影像的位置及角度，将虚拟信息叠加到真实世界中，为用户带来超越现实的感官体验。AR视频技术不仅极大地丰富了我们的视觉体验&a…
阅读更多...
SAP 接口-银行账号主数据维护接口【MDM-＞SAP】开发说明书（包括测试样例、程序代码仅作参考，不保证一定可以运行)

SAP 接口-银行账号主数据维护接口【MDM-＞SAP】开发说明书（包括测试样例、程序代码仅作参考，不保证一定可以运行)

接口映射字段 开发通用说明 根据MDM传输字段调用BAPI生成银行账号及开户行。 开户行维护BAPI【BAPI_BANK_CREATE】 银行账号维护BAPI【BAPI_FCLM_BAM_AMD_BNKANT】 接口字段【ZZZH 主账户标识】=1时字段【DTAAI】DME标识赋值：常用； 接口字段【ZZZH 主账户标识】=0时字段…
阅读更多...
最新文章

Copyright @ 2022~2023