【JavaScript基础】注释书写介绍

行内注释

//(双斜线)与代码之间保留一个空格，并且//(双斜线)与注释文字之间保留一个空格。

1. // 用来显示一个解释
2. // -> 用来显示表达式的结果
3. // >用来显示 console 的输出结果

function test() { // 测试函数 
    console.log('Hello World!'); // >Hello World! 
    return 3 + 2; // ->5 
}

普通单行注释

// 调用了一个函数；单独在一行 
setClass();

函数注释

更多注释标签可参考JSDoc文档：JSDoc: 一个JavaScript API文档生成器 | JSDoc中文网

/** 
  * @description 创建支付订单 
  * @author hello
  * @returns {Promise} 
  * @param {String} payMode 支付场景/方式： WXXCX（微信小程序）、WXGZH（微信公众号）、ALIPAY（支付宝） 
  * @param {String} orderId 订单Id 
  * @param {String} [openId] openId 非必填 
  */ 
const createPayOrder = (payMode, orderId, openId) => { 
    console.log('params:', payMode, orderId, openId) 
    return new Promise() 
}

使用JSDoc自动生成代码文档

全局安装jsdoc：npm install -g jsdoc

使用如下命令生成文档：jsdoc 文件名

会自动生成一个名为out的新文件夹，打开文件夹中的index.html，可以看到生成好的文档。