啥也不会的前端码农 2024-09-03 14:58 采纳率: 33.3%
浏览 9

JSDoc如何快速多个继承注解?

在观看了多个方法以及询问了chatGPT,貌似并没有继承注释的方法
目前我想要的效果是 test 能够去继承 dayjsTimeFormat 的注释

img

所希望能达到的效果图如下:

img

请问各位有无推荐的办法?我不想进行复制粘贴,因为不利于后期的维护与开发,非常感谢

  • 写回答

1条回答 默认 最新

  • Nymph_Zhu 2024-09-03 16:01
    关注

    创建一个公共注释块,并在多个地方引用它。
    JSDoc 支持使用 {@link} 标签来引用其他函数或变量的文档,因此你可以创建一个公共注释部分,然后在需要的地方使用 {@link} 引用它。
    例如:

    /**
     * 公共注释部分
     * @param {string} param0 - 参数描述
     */
    function commonComment(/** @type {string} */param0) {
      // 函数实现
    }
     
    /**
     * 继承公共注释
     * @param {string} param0 - {@link commonComment} 中的 param0 描述
     */
    function myFunction(/** @type {string} */param0) {
      // 函数实现
    }
    
    评论

报告相同问题?

问题事件

  • 修改了问题 9月3日
  • 修改了问题 9月3日
  • 创建了问题 9月3日