JSDoc:条件忽略是否可能?

您可以实现自己的 jsdoc plugin 测试忽略条件并在中设置其值 doclet.ignore 所有物将其设置为 true 将阻止处理doclet,而不是将其添加到最终文档中。

exports.defineTags = function(dictionary) {

    var env = require('jsdoc/env');

    /*
     * Usage: @customIgnore prod, test
     */
    dictionary.defineTag('customIgnore', {

        mustHaveValue: true,

        onTagged: function(doclet, tag) {
            var i;

            // "envParams" is a property of your jsdoc.json
            var environments = env.conf.envParams; 

           // Will hold "prod, test"
            var tagValue = tag.value;

            var conditionValues = tag.value.split(",");
            for (i = 0; i < conditionValues.length && !doclet.ignore; i++) {            
                if (environments.indexOf(conditionValues[i].trim()) !== -1) {
                    doclet.ignore = true;
                }
            }

        }
    });
};