【问题标题】:jsdoc make all underscore methods privatejsdoc 将所有下划线方法设为私有
【发布时间】:2020-07-21 13:07:11
【问题描述】:

我有一个使用 jsdoc 的大型代码库。我们刚刚注意到很多私有方法没有@private 标志。

有没有办法设置配置以将所有以下划线开头的方法视为私有方法?我真的很想避免手动完成数百个文件。

【问题讨论】:

    标签: jsdoc


    【解决方案1】:

    我找到了答案。 我安装了这个: https://www.npmjs.com/package/jsdoc-autoprivate 不幸的是,缺乏文档。 在我的 jsdoc.conf.json 中,在源代码下,我必须将其添加为插件:

    "plugins": [
      "node_modules/jsdoc-autoprivate/autoprivate.js"
    ]
    

    它有效。

    【讨论】:

      【解决方案2】:

      如果其他人发现了这个问题,jsdoc 包含一个名为 underscore 的插件,它可以很好地做到这一点:

      "plugins": [
        "plugins/underscore.js"
      ]
      

      【讨论】:

        猜你喜欢
        • 2013-01-14
        • 2019-06-23
        • 2013-03-16
        • 2021-10-07
        • 1970-01-01
        • 2011-12-28
        • 2011-10-19
        • 1970-01-01
        • 2020-11-04
        相关资源
        最近更新 更多