如果没有注释,如何为函数生成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,它应该按照这里的示例提供,但插件中的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 */';
            }
        }
    }
};