Microsoft C++ 文档项目教程

1. 项目的目录结构及介绍

MicrosoftDocs/cpp-docs
├── docs
│   ├── microsoft
│   │   └── cpp
│   │       ├── standard-library
│   │       ├── ide
│   │       └── ...
├── github
│   ├── ISSUE_TEMPLATE
│   └── ...
├── localization-config
├── markdownlint.json
├── openpublishing
│   ├── build.ps1
│   ├── publish-config.json
│   └── redirection.json
├── whatsnew.json
├── CONTRIBUTING.md
├── LICENSE
├── LICENSE-CODE
├── README.md
├── SECURITY.md
└── ThirdPartyNotices

目录结构介绍

• docs: 包含所有C++文档的源文件，按主题分类，如standard-library、ide等。
• github: 包含GitHub相关的配置文件，如ISSUE_TEMPLATE。
• localization-config: 本地化配置文件。
• markdownlint.json: Markdown格式检查配置文件。
• openpublishing: 包含发布相关的配置文件，如build.ps1、publish-config.json、redirection.json。
• whatsnew.json: 更新日志配置文件。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• LICENSE-CODE: 代码许可证。
• README.md: 项目介绍文件。
• SECURITY.md: 安全指南。
• ThirdPartyNotices: 第三方通知文件。

2. 项目的启动文件介绍

README.md

README.md 是项目的介绍文件，包含了项目的基本信息、如何贡献、如何使用等内容。启动项目时，首先阅读此文件可以帮助你快速了解项目的基本情况。

openpublishing/build.ps1

openpublishing/build.ps1 是项目的构建脚本，用于生成文档的最终输出。启动项目时，运行此脚本可以生成文档的HTML或其他格式的输出。

3. 项目的配置文件介绍

markdownlint.json

markdownlint.json 是Markdown格式检查的配置文件，用于确保文档的格式一致性。

openpublishing/publish-config.json

openpublishing/publish-config.json 是发布配置文件，定义了文档发布时的各种设置，如发布路径、发布格式等。

openpublishing/redirection.json

openpublishing/redirection.json 是重定向配置文件，用于管理文档URL的重定向。

whatsnew.json

whatsnew.json 是更新日志配置文件，记录了项目的更新历史和重要变更。

CONTRIBUTING.md

CONTRIBUTING.md 是贡献指南，详细说明了如何为项目贡献代码或文档。

SECURITY.md

SECURITY.md 是安全指南，提供了项目的安全相关信息和最佳实践。

ThirdPartyNotices

ThirdPartyNotices 文件包含了项目使用的第三方库和工具的通知信息。