方法或函数前,请带上注释,增加代码可读性。
    在VS Code中,鼠标在方法/函数名上停留是,能看方法/函数的注释,方便理解。

    注释说明如下
    /*
    方法处理的业务说明

    @param {类型} 形参名 形参说明
    @return {类型} 返回值说明
    /
    示例

    1. /**
    2. * 求两个数值的和
    3. *
    4. * @param {Number} a 第一个数值
    5. * @param {Number} b 第二个数值
    6. * @return {Number} 两个数值的和
    7. */
    8. function sum(a, b){
    9. return a + b;
    10. }

    备注:VS Code中,输入一个’/‘,之后连续按两个’‘,就可以出现示例中的注释,换行后,’‘号回自动补齐。如下图所示。
    JSDoc注释.png