jsDoc是啥？

JSDoc是一个根据javascript文件中注释信息，生成JavaScript应用程序或库、模块的API文档 的工具。

怎么使用jsDoc

JSDoc本质是代码注释加上特有的格式和规范。

为啥使用jsDoc

我平常是在微信小程序项目中适用jsDoc,之前想尝试在原生微信小程序中适用typescript，但是太难用了，官方的demo也不太好使，后来机缘巧合之下知道了jsdoc。在小程序中使用后，编辑器就会很智能提示对应的参数类型，就很方便。

jsDo常用指南

函数参数

js
    /**
     *  test function
     * @param {string} p1 
     * @param {number} p2
     */
    const testFunc = (p1,p2)=>{
        console.log(p1,p2)
    }

上面函数中p1就是string类型，p2就是number类型

js
    /**
     *   obj 
     * @param {Object}  obj
     * @param {string}  obj.name
     * @param {number}  obj.age
     */
    const testObjFunc = ({name,age})=>{
      console.log(name,age)
    }

上面函数中obj.name就是string类型，obj.age就是number类型，obj就是传入的对象

js
    /**
     * @typedef {'app_id'|'device_id'|'chain_id'} Keys
     */
     
    /**
     *   obj 
     * @param {Object}  obj
     * @param {Keys}  obj.key  key的值是指定的字符串 Keys 是指定字符串的类型
     * @param {number}  [obj.age] 可选参数 用[]中括号
     * @param {object[]} obj.list[] 数组对象用属性名加[]
     */
    const testObj2Func = (obj)=>{
        console.log(obj)
    }

效果图