不存在注释时如何为函数生成 JSDoc 注释？

Question

我正在尝试为 JSDoc 创建一个插件。 我正在关注文档（具有讽刺意味的是，缺少文档），但我不确定如何执行此操作。

我的插件已正确加载，我正在尝试一个简单的示例。这是我的插件（加载，因为我可以从那里抛出一个错误来阻止 jsdoc 运行）：

visitNode: function(node, e, parser, currentSourceName) {

    if(node.type === 109){
        if(!e.comment || e.comment ==="@undocumented"){

            var startComment = '/**',
                endComment = '\n*/';
            var params = node.getParams(),
                paramsComment = '';
            for(var i=0; i<params.length; i++){
                paramsComment += '\n* @param ' + params[i];
            }

            e.comment = startComment +
                paramsComment +
                endComment;
        }
    }

请注意 node.type === 109 等价于 Token.FUNCTION，根据他们的示例 here 应该可用，但插件中未定义 Token。

如果您知道一个更好的网站来解释如何编写 JSDoc 插件，那也将非常感激...谢谢

Answer 1

我也遇到了这个问题，奇怪的是 JSDoc 没有某种已经为该选项或至少一个插件提供的选项。

无论如何创建这个插件已经解决了我的问题。我正在使用 JSDoc 3.4 版：

'use strict';
exports.handlers = {

    symbolFound:function(e) {
        if(e.astnode.type === "FunctionDeclaration" ) {
            if( (e.comment==="@undocumented")){
                e.comment = '/** undocumented */';
            }
        }
    }
};