跳到主要内容

任务列表

任务列表是 GitHub Flavored Markdown 的扩展功能，用于创建待办事项清单。它在项目管理、任务跟踪等场景中非常实用。

基本语法​

任务列表在列表项中添加方括号，使用 x 标记完成状态。

创建任务列表​

- [x] 已完成的任务
- [ ] 未完成的任务
- [ ] 另一个未完成的任务

渲染效果：

  • 已完成的任务
  • 未完成的任务
  • 另一个未完成的任务

语法规则​

  • 方括号前后必须有空格
  • 方括号内使用小写 x 表示完成
  • 方括号内为空格表示未完成

无序列表任务​

使用 - 或 * 创建无序任务列表：

- [x] 学习 Markdown 基础
- [x] 学习 Markdown 进阶
- [ ] 学习 Markdown 高级特性
- [ ] 完成实践项目

有序列表任务​

使用数字创建有序任务列表：

1. [x] 第一步：环境准备
2. [x] 第二步：安装依赖
3. [ ] 第三步：配置项目
4. [ ] 第四步：运行测试

嵌套任务列表​

任务列表支持嵌套，用于表示子任务：

- [x] 项目规划
  - [x] 需求分析
  - [x] 技术选型
  - [ ] 时间估算
- [ ] 项目开发
  - [x] 搭建框架
  - [ ] 实现功能
    - [ ] 用户模块
    - [ ] 订单模块
  - [ ] 编写测试
- [ ] 项目部署

渲染效果：

  • 项目规划
    • 需求分析
    • 技术选型
    • 时间估算
  • 项目开发
    • 搭建框架
    • 实现功能
      • 用户模块
      • 订单模块
    • 编写测试
  • 项目部署

任务列表的应用场景​

项目 README​

在项目 README 中展示开发进度：

## 开发进度

- [x] 核心功能
  - [x] 用户认证
  - [x] 数据存储
  - [x] API 接口
- [ ] 扩展功能
  - [ ] 数据导出
  - [ ] 消息通知
- [ ] 文档完善
  - [x] API 文档
  - [ ] 使用指南

问题追踪​

在 Issue 中跟踪问题解决进度：

## 问题排查清单

- [x] 复现问题
- [x] 定位原因
- [ ] 制定方案
- [ ] 实施修复
- [ ] 验证结果

会议记录​

记录会议待办事项：

## 会议待办

- [x] 确认会议时间
- [x] 准备会议材料
- [ ] 发送会议邀请
- [ ] 整理会议纪要

学习计划​

制定学习计划：

## 学习计划

- [x] Markdown 基础语法
- [x] Markdown 表格和列表
- [ ] Markdown 数学公式
- [ ] Markdown 图表绘制

GitHub 中的任务列表​

在 GitHub 上，任务列表有特殊功能：

Issue 中的任务列表​

在 Issue 中创建任务列表，会显示进度条：

## 任务清单

- [x] 任务一
- [x] 任务二
- [ ] 任务三
- [ ] 任务四

GitHub 会在 Issue 标题旁显示完成进度（如 2/4）。

Pull Request 中的任务列表​

在 PR 描述中使用任务列表，可以：

  • 显示完成进度
  • 追踪代码审查任务
  • 管理合并前检查项

可交互​

在 GitHub 网页界面，可以直接点击复选框更改任务状态，无需编辑源文件。

任务列表与普通列表混用​

任务列表可以与普通列表混用：

- 项目概述
  - 这是一个普通列表项
  - [x] 这是一个任务项
  - 另一个普通列表项
- [ ] 待办事项
  - 说明文字
  - [x] 子任务

任务列表中的格式化​

任务项可以包含其他 Markdown 格式：

- [x] 阅读 [官方文档](https://commonmark.org)
- [x] 学习 `git` 命令
- [ ] 完成 **练习题**
- [ ] 提交 ~500~ 1000 字报告

渲染效果：

  • 阅读 官方文档
  • 学习 git 命令
  • 完成 练习题
  • 提交 500 1000 字报告

特殊情况处理​

方括号转义​

如果需要在列表项中显示方括号，使用反斜杠转义：

- [ ] 这是一个任务，包含 \[方括号\]

以括号开头的任务​

如果任务描述以括号开头，需要转义：

- [ ] \(可选) 这是一个可选任务

最佳实践​

清晰的任务描述​

任务描述应该清晰明确：

推荐：

- [ ] 完成用户登录功能的前端页面开发

不推荐：

- [ ] 做登录

合理的层级结构​

使用嵌套表示任务分解：

- [ ] 用户模块
  - [ ] 注册功能
  - [ ] 登录功能
  - [ ] 个人中心

及时更新状态​

完成任务后及时更新状态，保持列表的准确性。

与标题配合使用​

在标题下组织相关任务：

## 第一阶段：基础功能

- [x] 用户认证
- [x] 数据存储

## 第二阶段：高级功能

- [ ] 搜索功能
- [ ] 数据分析

小结​

本章学习了任务列表的使用方法：

  1. 基本语法：- [ ] 未完成，- [x] 已完成
  2. 嵌套任务：使用缩进表示子任务
  3. 应用场景：项目进度、问题追踪、学习计划
  4. GitHub 特性：进度显示、可交互
  5. 最佳实践：清晰描述、合理层级、及时更新

练习​

  1. 创建一个包含嵌套任务的项目计划
  2. 在任务列表中使用链接和代码格式
  3. 创建一个学习计划任务列表
  4. 尝试在 GitHub Issue 中创建任务列表