plugins - 没有注释时如何为函数生成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 */';
            }
        }
    }
};