编辑“︁JavaScript注释规范”︁（章节）

== 注释风格指南 ==

=== 1. 文件头注释 ===
每个文件顶部建议包含：

<syntaxhighlight lang="javascript">
/**
 * @file 用户认证模块
 * @author 张三
 * @version 1.0.0
 * @license MIT
 * @description 处理用户注册、登录和权限验证
 */
</syntaxhighlight>

=== 2. 函数注释 ===
使用JSDoc规范：

<mermaid>
classDiagram
    class FunctionComment {
        +description: string
        +@param: Param[]
        +@returns: string
        +@throws: string[]
        +@example: string
    }
    class Param {
        +name: string
        +type: string
        +description: string
    }
</mermaid>

=== 3. 复杂逻辑注释 ===
对复杂算法添加说明：

<syntaxhighlight lang="javascript">
// 使用Dijkstra算法计算最短路径
// 1. 初始化距离数组，设置起点距离为0
// 2. 创建未访问节点集合
// 3. 当未访问集合不为空时：
//    a. 选择当前距离最小的节点
//    b. 更新邻居节点的距离
//    c. 标记当前节点为已访问
function dijkstra(graph, start) {...}
</syntaxhighlight>