注释和文档应清晰说明代码的意图与背景，而非重复实现；JavaScript因类型不明确更需有效注释。重点包括：在必要处解释“为什么”，避免描述“做什么”；使用JSDoc规范函数参数、返回值类型，提升可读性与工具支持；模块顶部说明职责与注意事项，帮助理解上下文；保持注释与代码同步，纳入代码审查流程，确保长期维护有效性。
写好注释和文档不是为了应付检查，而是为了让代码更容易被别人（包括未来的自己）理解。JavaScript作为一门动态、灵活的语言，尤其需要清晰的说明来弥补类型不明确带来的阅读障碍。重点不是多写，而是写得有用。
只在必要处添加注释
好的代码是自解释的，变量名、函数名应尽量表达意图。注释不该重复代码做了什么，而应说明为什么这么做。
例如：-
差的注释：
// 增加计数器——counter++本身已经很清楚了 -
好的注释：
// 使用 setTimeout 是为了避开 React 渲染周期中的状态冲突—— 解释了选择这种实现的原因
复杂逻辑、边界处理、算法选择或临时 workaround 都值得用一两句话说明背景。
使用 JSDoc 规范函数文档
JSDoc 能让 IDE 提示参数类型，也方便生成静态文档。对公共函数或模块接口建议使用。
立即学习“Java免费学习笔记（深入）”；
基本写法示例：/**
* 计算折扣后的价格
* @param {number} price - 原价，必须大于 0
* @param {number} discount - 折扣率，范围 0-1
* @returns {number} 折后价格，保留两位小数
*/
function calculateDiscount(price, discount) {
return Number((price * (1 - discount)).toFixed(2));
}
这样调用时编辑器会自动提示参数类型和含义，减少出错可能。
高级Bash脚本编程指南 chm版
下载
这本书假定你没有任何关于脚本或一般程序的编程知识, 但是如果你具备相关的知识, 那么你将很容易就能够达到中高级的水平. . . 所有这些只是UNIX®浩瀚知识的一小部分. 你可以把本书作为教材, 自学手册, 或者是关于shell脚本技术的文档. 书中的练习和样例脚本中的注释将会与读者进行更好的互动, 但是最关键的前提是: 想真正学习脚本编程的唯一途径就是亲自动手编写脚本. 这本书也可作为教材来讲解一般的编程概念. 向伟大的中华民族的Linux用户致意! 我希望这本书能够帮助你们学习和理解L
模块顶部写简要说明
每个文件开头用几句话说明这个模块的职责、使用场景和关键注意事项。
例如：/** * 用户权限校验工具 * 提供基于角色的访问控制（RBAC）判断 * 注意：依赖全局 window.user 对象，确保在用户登录后加载 */
这类说明帮助读者快速定位模块用途，避免误用。
保持注释与代码同步
过时的注释比没有更糟。修改代码时顺手更新相关注释，特别是参数变更或逻辑调整后。
可以把注释更新纳入代码审查清单中，团队形成习惯后维护成本会降低。
基本上就这些。不复杂，但容易忽略。关键是把注释当成代码的一部分来对待，而不是附属品。
