Skip to content

写作规范

本规范用于所有 Java 课程、手册和面试内容。目标是让每篇内容可学习、可运行、可复习,并清楚区分 Java 规范保证、具体实现行为和项目建议。

课程模板

每篇课程按十二段组织:

  1. 学习目标:列出学习后能完成的行为,不写空泛口号。
  2. 前置知识:说明需要已掌握的概念、工具和章节。
  3. 真实问题场景:用一个具体业务或工程问题引入主题。
  4. 核心概念:解释术语、模型和使用边界。
  5. 原理与设计思想:说明为什么这样设计,以及取舍是什么。
  6. 可运行代码:提供 Java 21 可编译、可测试或可直接运行的示例。
  7. 常见错误与排查:列出症状、原因、验证方式和修复方向。
  8. 最佳实践及边界:说明推荐做法、适用条件和不适用场景。
  9. 分级练习:至少包含基础、进阶、挑战三个等级。
  10. 面试与复习题:覆盖概念理解、代码判断和工程取舍。
  11. 本章总结:回到学习目标,提炼关键结论。
  12. 下一步:指向后续章节、练习或手册条目。

Frontmatter

所有正式内容必须包含:

yaml
---
status: learning-ready
javaVersion: "21"
verifiedAt: "2026-06-23"
---
  • status 使用 planneddraftlearning-readyverified
  • javaVersion 默认写 "21";若内容与版本无关,也保留该字段表示验证基线。
  • verifiedAt 使用 YYYY-MM-DD;未验证内容不得标为 verified

Java 21 与代码要求

  • 示例代码以 Java 21 为基线,优先使用标准库和 Maven。
  • 代码必须能复制运行,或明确给出所在模块、运行命令和预期输出。
  • 涉及并发、I/O、数据库、网络或框架时,应提供最小可验证路径。
  • 代码片段不得依赖隐藏上下文;省略内容时必须说明省略不影响当前知识点。

练习等级

  • 基础:验证概念和语法,单点目标,适合跟练。
  • 进阶:组合多个知识点,要求设计接口、处理异常或补充测试。
  • 挑战:接近真实工程,要求考虑边界、性能、并发、安全或可维护性。

表述边界

  • 规范保证:来自 Java 语言规范、JDK API 契约或稳定协议,可用“保证”“必须”等表述。
  • 具体实现:来自 HotSpot、某个库、某个版本或默认配置,必须写明实现和版本范围。
  • 项目建议:来自工程经验、团队约定或教学取舍,应使用“建议”“通常”“在本项目中”等表述。

不要把实现细节写成语言保证,也不要把教学项目的简化方案包装成通用最佳实践。