7.4.1 Kernel Doc 规范

文档摘要

7.4.1 Kernel Doc 规范在 Linux 内核开发的浩瀚星图中，代码是骨架，而文档——尤其是 ——是流淌其间的神经传导通路。它不执行指令，却决定着千万开发者能否在凌晨三点读懂一段的语义；它不分配内存，却左右着新贡献者第一次时是看到清晰的 API 描述，还是满屏的红色警告。7.4.1 Kernel Doc 规范，远非一份“建议性指南”，而是内核社区为自身可持续演进所锻造的一套可编译、可验证、可追溯、可自动化消费的元语言契约。它把“写注释”这件事，升格为与编写 C 代码同等严肃的系统工程。我们今天要拆解的，不是“应该写文档”的道理，而是：当你的光标停在第 2843 行，准备为函数添加内核文档时，你究竟该敲下哪几行字符？为什么必须这样缩进？为什么的冒号后要空两格？