如何使用JSDoc为JS中的final method添加文档标注？

Java中的final方法核心是标注方法不可被重写，JSDoc实际上有对应的实现方式，可按你的使用场景选择：

1. 使用官方内置@final标签 #

JSDoc 3.3及以上版本已经内置支持@final标签，专门用来标记类成员不可被重写、不可在继承类中修改，标注后生成的文档会明确展示该属性。
示例代码：

class BaseClass {
  /**
   * 全局通用初始化逻辑，禁止子类重写
   * @final
   * @param {Object} options 初始化配置
   * @returns {void}
   */
  init(options) {
    // 内部实现逻辑
  }
}

2. 低版本JSDoc兼容方案 #

如果你使用的JSDoc版本不支持内置@final标签，可以用两种方式实现：

• 直接在方法描述中加明确说明，用禁止子类重写这类强调文本标注，阅读文档的开发者可以直接看到约束
• 自定义JSDoc标签：在JSDoc的配置文件（通常为jsdoc.json）中添加自定义标签规则，把@final加入可识别标签列表，生成文档时同样会展示该标记

3. TypeScript场景增强 #

如果你的项目配合TypeScript使用，可以在@final标签之外搭配readonly修饰符，不仅文档会有标记，TS编译阶段还会主动校验、阻止子类重写该方法的行为。

内容的提问来源于stack exchange，提问作者user5507535