C++ Core Guidelines 项目教程

C++ Core Guidelines 项目教程

CppCoreGuidelines The C++ Core Guidelines are a set of tried-and-true guidelines, rules, and best practices about coding in C++ 项目地址: https://gitcode.com/gh_mirrors/cp/CppCoreGuidelines

1. 项目目录结构及介绍

C++ Core Guidelines 项目的目录结构如下：

CppCoreGuidelines/
├── .github/
│   └── workflows/
├── _includes/
├── _layouts/
├── docs/
├── public/
├── scripts/
├── talks/
├── .gitignore
├── .travis.yml
├── CONTRIBUTING.md
├── CppCoreGuidelines.md
├── LICENSE
├── README.md
├── SECURITY.md
├── _config.yml
├── cpp_core_guidelines_16b.png
├── cpp_core_guidelines_logo_text.png
├── index.html
├── param-passing-advanced.png
├── param-passing-normal.png
└── params.json

目录介绍

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• _includes/: 包含用于构建文档的包含文件。
• _layouts/: 包含文档的布局模板。
• docs/: 包含项目的文档文件。
• public/: 包含公共资源文件。
• scripts/: 包含用于构建和测试的脚本文件。
• talks/: 包含与项目相关的演讲材料。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• CONTRIBUTING.md: 贡献指南。
• CppCoreGuidelines.md: 核心指南文档。
• LICENSE: 项目许可证。
• README.md: 项目介绍和使用说明。
• SECURITY.md: 安全指南。
• _config.yml: 项目配置文件。
• cpp_core_guidelines_16b.png: 项目图标。
• cpp_core_guidelines_logo_text.png: 项目图标。
• index.html: 项目主页。
• param-passing-advanced.png: 参数传递示意图。
• param-passing-normal.png: 参数传递示意图。
• params.json: 参数配置文件。

2. 项目启动文件介绍

项目的启动文件是 index.html。这个文件是项目的主页，包含了项目的介绍、使用说明以及相关链接。用户可以通过访问这个文件来了解项目的基本信息和使用方法。

3. 项目配置文件介绍

项目的配置文件主要包括以下几个：

• _config.yml: 这是 Jekyll 项目的配置文件，用于配置项目的各种设置，如网站标题、描述、作者信息等。
• .travis.yml: 这是 Travis CI 的配置文件，用于配置持续集成和持续部署的流程。
• params.json: 这是一个参数配置文件，可能用于存储项目的某些配置参数。

这些配置文件帮助开发者管理和配置项目的各种设置，确保项目能够按照预期的方式运行和部署。

CppCoreGuidelines The C++ Core Guidelines are a set of tried-and-true guidelines, rules, and best practices about coding in C++ 项目地址: https://gitcode.com/gh_mirrors/cp/CppCoreGuidelines