开发规范备忘录

57 阅读1分钟
  • 在描写注释时,推荐格式化且统一的注释风格,在写注释时尽量描述写代码时的思路,而不是代码做了什么。

    // bad 
    
    //获取订单  
    function getOrderByID(id){  
    var order;  
    //...  
    return order;  
    }  
    
    
    // good 方法的注释应该统一用块级注释   
    
    /**  
     * 根据订单id获取订单详细数据  
     * @param {[number]} id [订单ID]  
     * @return {[order]} [订单详细信息]  
     */  
    function getOrderByID(id){  
     var order;  
     //...  
     return order;  
    }
    
  • 保持函数的单一职责原则

    让一个函数只专注于一件事情,能够很好的解耦各个功能之间的联系,使得后续对某一个功能进行更改时,不用担心会影响其他模块。