使用说明
d2mcpp是一个强调动手实践的现代C++核心语言特性教程项目。基于xlings(d2x)工具搭建了一套编译器驱动开发模式的代码练习, 可以自动化的检测练习代码的状态和跳转到下一个练习...
0.xlings工具安装
xlings包含教程项目所需的工具 - 更多工具细节
Linux
curl -fsSL https://raw.githubusercontent.com/openxlings/xlings/main/tools/other/quick_install.sh | bash
or
wget https://raw.githubusercontent.com/openxlings/xlings/main/tools/other/quick_install.sh -O - | bash
Windows - PowerShell
Invoke-Expression (Invoke-Webrequest 'https://raw.githubusercontent.com/openxlings/xlings/main/tools/other/quick_install.ps1' -UseBasicParsing).Content
装好 xlings 后, 用它装本教程需要的两个工具
xlings install d2x mcpp -y # d2x: 练习框架 CLI | mcpp: C++ 构建与测试工具
1.获取项目及自动配置环境
下载项目到当前目录并自动配置本地环境
d2x install d2mcpp
验证环境
进入项目目录后跑一遍参考答案, 确认工具链是通的
cd d2mcpp
mcpp test -p solutions # 验证环境: 52 份参考答案, 应当全绿
solutions/本身就是一个 mcpp 工程(solutions/mcpp.toml+solutions/tests/), 所以这条命令会真的编译并运行全部 52 份参考答案 —— 全绿即工具链就绪。答案与练习的对应关系就是
tests/下的相对路径:solutions/tests/cpp11/00-auto-and-decltype/0.cpp←→src/cpp11/tests/00-auto-and-decltype/0.cpp。 想只看某一部分:mcpp test -p solutions cpp11。
本地电子书
可以在项目目录执行
d2x book命令, 打开本地文档(包含使用说明和电子书)
d2x book
练习代码自动检测
进入项目目录
d2mcpp运行checker命令, 进入练习代码自动检测程序
d2x checker
指定练习进行检测
d2x checker [name]
注: 练习名支持模糊匹配
查看学习进度
只读的进度总览,按章节聚合,不进入练习模式
d2x status
原生模式(可选)
每个 C++ 标准目录都是真实的 mcpp 工程,练习就是它的 tests/——不经过 d2x,直接用 mcpp 也能练:
mcpp test # 你的完整进度表(动手前全红, 那就是起点)
mcpp test -p src/cpp11 # 整个 cpp11 的进度表(哪题绿哪题红)
mcpp test -p src/cpp11 03-trailing # 只跑名字匹配的练习
同步最新的练习代码
项目处于持续更新阶段,更新使用 git(注意先保存/提交你已修改的练习):
git pull
2.自动化检测程序简介
使用d2x checker进入自动化代码练习环境后, 工具会自动定位打开对应的练习代码文件, 并在控制台输出提示编译器的错误及提示信息。一般检测程序分两个检测阶段: 第一个是编译期检测, 即你需要通过练习代码中的提示信息和控制台编译器的报错, 修复代码的编译错误; 第二个是运行时检测, 即当前代码运行时是否能通过所有检查点。当修复编译错误并通过所有检查点时, 控制台就会显示当前练习通过并提示你进入下一个练习
代码练习文件示例
// d2mcpp: https://github.com/mcpp-community/d2mcpp
// license: Apache-2.0
// file: src/intro/tests/hello-mcpp.cpp
//
// Exercise/练习: 自动化代码练习使用教学
//
// Tips/提示:
// 这是一个「练习即测试」的自动化代码练习项目。两种使用方式任选:
//
// d2x checker 引导模式: 自动检测,通过后进入下一题
// mcpp test -p src/intro 原生模式: 直接使用 mcpp 运行, 测试报告即学习进度
//
// 你需要根据控制台的报错和提示信息修改代码。约定只有三个:
//
// - D2X_YOUR_ANSWER: 填空占位符 —— 用正确的代码替换它。它不是宏,
// 只是一个没人定义的名字, 所以编译器会指着它报错, 那就是要填的地方
// - d2x::check / d2x::check_eq: 运行时检查点, 修复代码让所有检查通过
// (不能直接删除检查点)
// - d2x::wait(): 练习之间的路障 —— 读完这一课, 删掉它才算真正完成
//
// Auto-Checker/自动检测命令:
//
// d2x checker hello-mcpp
//
import std;
import d2x;
// 修改代码时可以观察到控制台"实时"的变化
int main() {
std::cout << "hello, mcpp!" << std:endl; // 0.修复这个编译错误
int a = 1.1; // 1.修复这个运行时错误, 修改int为double, 通过检查
d2x::check_eq(a, 1.1, "a == 1.1"); // 2.运行时检查点, 需要修复代码通过所有检查点(不能直接删除检查点代码)
D2X_YOUR_ANSWER b = a; // 3.修复这个编译错误, 给b一个合适的类型
d2x::check_eq(b, 1, "b == 1"); // 4.运行时检查点2
d2x::wait(); // 5.删除或注释掉这一行, 进入下一个练习(项目正式代码练习)
return 0;
}
控制台输出及解释
🌏Progress: [>----------] 0/52 -->> 显示当前的练习进度
[Exercise: hello-mcpp] -->> 当前的练习名
❌ Error: Compilation/Running failed for src/intro/tests/hello-mcpp.cpp -->> 显示检测状态
The code exist some error!
---------Output--------- - 编译/运行输出信息
❌ | a == 1.1 (1 == 1.1) --> src/intro/tests/hello-mcpp.cpp:41 -->> 错误提示及位置(41行)
🚧 | Delete the d2x::wait() to continue --> src/intro/tests/hello-mcpp.cpp:47
AI-Tips-Config: https://xlings.d2learn.org/documents/d2x/intro.html -->> AI提示(需要配置大模型的key, 可不使用)
---------E-Files---------
src/intro/tests/hello-mcpp.cpp -->> 当前检测的文件
-------------------------
Homepage: https://github.com/openxlings/xlings
3.配置项目(可选)
配置语言
编辑项目配置文件.d2x.json中的lang属性, zh对应中文, en对应英文
{
"version": "0.1.1",
"buildtools": "mcpp run -q -p d2x/buildtools --",
"lang": "en", < -- 修改这里
...
}
自定义编辑器 - 以nvim编辑器为例
如果你希望使用 Neovim 编辑器并获得 LSP（clangd）支持, 可以按如下步骤进行配置
1.编辑项目配置文件.d2x.json中的editor字段, 设置为nvim (或zed)
{
"buildtools": "mcpp run -q -p d2x/buildtools --",
"editor": "nvim",
...
}
未配置时按
$VISUAL→$EDITOR→code回退;支持{file}占位符;显式配空串表示关闭自动打开。
2.在项目根目录运行一键依赖安装和环境配置命令
xlings install
3.在项目目录, 重新运行检测命令 d2x checker 就会使用nvim打开对应练习文件， 并具备练习自动跳转/切换功能
注: nvim编辑器下的"实时检测功能"的触发时机, 将会对应到
:w命令. 即修改代码后, 在nvim的命令行模式对文件进行保存(:w)时, d2x就会更新检测结果
4.资源于交流
交流群(Q): 167535744
教程讨论版块: https://forum.d2learn.org/category/20
xlings: https://github.com/openxlings/xlings