最近爲了規範化代碼風格,項目組內啓用了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中的代碼如下圖所示: