js函数注释方式

在写代码的过程中（不局限于JavaScript），不管是为了方便以后自己修改，还是方便他人阅读，都需要在代码中增加相应的注释。而某些技术不是很好的，但是又想写出逼格很高的代码，无非就是让别人很难阅读，可是，过了一周、一个月，半年，某一天产品经理要求在项目中改动一些功能，或者是软件优化升级，再回头看当初的代码，自己都是一脸懵逼，“这都写的啥啊，不会是个傻子吧！”，这时候，代码注释就显得尤为重要了，这也是一个前线码农的基本职业素养。不多说，介绍一种既不影响代码阅读（注释如果写在行间的话，会影响代码可读性），又不影响代码理解的注释方法。看代码（仅供新手参考，大神请绕行.....）

 

/*  
        *   randomNum 利用random函数生成一组随机数（两个） 
        *
        *   版本：（版本：如果有版本需要说明版本的作用以及被注释的版本名称）
        *       1.01
        *   作者：
        *       夫_子
        *   时间：
        *       2018年12月13日
        *   
        *   参数：
        *       minNum  最小值   number  默认值10
        *       maxNum  最大值   number  默认值100
        *       注意：此函数返回一组对象，一次产生两个随机数
        * 
        *   return：
        *       size  返回的是一组随机数对象   object
        * 
        *   1、根据传入的参数设置产生随机数的范围，如果没有传入参数，默认范围为10-100；
        *   2、创建一个对象size，用来存储产生的一组随机数，对象的两个属性分别为x，y，属性值对应产生的两个随机数。
        *   3、返回创建的对象。
        * 
        * 
        * 
        *
        */



        //一组随机数
        function randomNum(minNum,maxNum){
            var minNum=minNum||10;
            var maxNum=maxNum||100;
            var size={};
            size.x = parseInt(Math.random()*(maxNum-minNum)+minNum);
            size.y = parseInt(Math.random()*(maxNum-minNum)+minNum);
            return size;

             /* 1.01
            name
            */
        }