代码块与链接引用
你将学会什么
Section titled “你将学会什么”- 用带语言标注的代码块展示命令
- 复杂命令先写一句说明，再贴代码
- 区分内部路径链接与外部资源链接的写法
课程作业和技术文档里，命令和代码是最容易被误写的地方。建议你这样做：
- 标明语言类型，方便高亮
- 只保留必要命令，不要截图整段终端
- 复杂命令先写一句话说明，再贴代码
# 安装依赖npm install# 启动项目npm run dev不要默认认为所有人都和你用同一套环境，一句「在项目根目录执行」就能减少很多误解。链接也一样，不是「能跳就行」，而是要让读者知道点击后能得到什么，建议格式是：
- 内部路径说明当前页相对位置
- 外部链接说明资源类型，例如「官方文档」「参考实现」「课程要求」
不要只写「参考这里」，而要写「参考这里了解 API 设计约束」。信息越具体，读者越愿意点击。
先自己回答，再看答案：
- 代码块为什么一定要标明语言类型？
- 什么时候应该先写一句说明再贴命令？
- 为什么「参考这里」这样的链接不够好？
参考答案
- 标明语言类型才能正确高亮，读者一眼能看出命令与输出的区别。
- 当命令依赖特定环境或位置（如「在项目根目录执行」）时，先说明能减少误解。
- 它没有告诉读者点击后能得到什么，信息不具体，读者不愿意点。
- 代码块标语言、只留必要命令，不要截图整段终端
- 先说明环境与位置，再贴命令
- 链接要写清「点了能得到什么」