Skip to content

Markdown 与学习记录 ​

Markdown 是一种适合写文档、笔记和技术说明的轻量标记语言。它几乎可以用任何文本编辑器打开,也能方便地转换为网页、PDF 或其他格式。

为什么值得学习 ​

学习编程时,代码只是过程的一部分。你还应该说明为什么这样实现、遇到了什么问题、尝试过哪些方法。Markdown 可以让你用很小的格式成本留下这些内容。

相比把内容分散在聊天记录和临时文本中,Markdown 文档有几个明显优势:

  • 标题、列表和代码块结构清楚。
  • 文件体积小,方便版本管理和分享。
  • 可以放进 GitHub 仓库,和代码一起维护。
  • 适合记录长期的学习过程。

常用语法 ​

掌握下面这些基础语法,就能完成大部分学习文档:

  • # 到 ######:表示不同层级的标题。
  • - 或 1.:表示无序或有序列表。
  • **文字**:表示加粗。
  • > 文字:表示引用。
  • `代码`:表示行内代码。
  • 三个反引号:表示多行代码块。
  • [文字](链接):表示超链接。

不需要为了排版研究太多扩展语法。最重要的是让阅读者快速看懂你的结论和过程。

怎样记录一道题 ​

一道题的学习记录可以按照下面顺序写:

  1. 题目要求和我理解的目标。
  2. 我参考了哪些知识或资料。
  3. 我怎样拆分任务。
  4. 关键代码和运行结果。
  5. 遇到的问题、排查过程和原因。
  6. 目前仍然不确定或可以继续优化的地方。

如果使用 AI 或开源代码,也建议说明它们帮助你解决了哪一部分,以及你自己做了哪些修改。

怎样写项目说明 ​

项目仓库可以增加一份 README.md,说明项目目的、运行环境、启动步骤、主要功能和目录结构。好的 README 能让别人不依赖聊天记录就能把项目跑起来。

摘要不需要写得像正式论文,但要尽量具体。例如“完成了登录功能”可以改成“使用数据库校验用户名和密码,成功返回 200,失败返回 401,并补充了异常处理”。

保持记录的原因 ​

学习记录不是为了增加工作量,而是帮助你在几周后仍然知道当时做了什么。面试或比赛答辩时,你可以从记录中找到真实的问题、判断和改进过程,而不是临时回忆。

文档不需要一次写完。每完成一小步就补充几行,长期积累下来会比最后集中补写更自然。

参考教程 ​

Released under the MIT License.