Missing JSDoc comment. eslint (require-jsdoc)- 代码规范性问题

最近为了规范化代码风格,项目组内启用了VSCode插件eslint,书写下面的代码时会提示警告:

Missing JSDoc comment. eslint (require-jsdoc)

对应的代码如下: 

    // 处理输入参数
    function handleArgv(argv) {
        const prefix = `${PROTOCOL}:`;
        let url = null;

        if (argv[argv.length - 1].toLowerCase().indexOf(prefix.toLowerCase()) > -1) {
            url = argv[argv.length - 1];
        }
        console.log('# url=', url);
        logger.log('# url=', url);
        if (url) {
            handleUrl(url);
        }
    }

IDE中会在相应的代码部分生成红色的波浪线,现象如下图所示: 

原因是方法的注释方式不正确,确切的说是不合适,修改后的代码如下:

    /**
     * 处理输入参数
     * @param {Object} argv
     */
    function handleArgv(argv) {
        const prefix = `${PROTOCOL}:`;
        let url = null;

        if (argv[argv.length - 1].toLowerCase().indexOf(prefix.toLowerCase()) > -1) {
            url = argv[argv.length - 1];
        }
        console.log('# url=', url);
        logger.log('# url=', url);
        if (url) {
            handleUrl(url);
        }
    }

修改注释方式后,问题解决,红色的波浪线消失了,IDE中的代码如下图所示: 

猜你喜欢

转载自blog.csdn.net/liuzehn/article/details/107021874