js命名规范


js命名规范

  驼峰命名法:

  1. Pascal Case 大驼峰式命名法:首字母大写。eg:StudentInfo、UserInfo、ProductInfo
  2. Camel Case 小驼峰式命名法:首字母小写。eg:studentInfo、userInfo、productInfo

  1.项目命名    

    全部采用小写方式, 以下划线分隔。

    示例:my_project_name

  2.目录命名

    参照项目命名规则;有复数结构时,要采用复数命名法。

    示例:scripts, styles, images, data_models

  3.JS文件命名

    1.变量:必须采用小驼峰式命名法。

      命名规范:前缀应当是名词。(函数的名字前缀为动词,以此区分变量和函数)

      命名建议:尽量在变量名字中体现所属类型,如:length、count等表示数字类型;而包含name、title表示为字符串类型。

    2.常量:必须采用全大写的命名,且单词以_分割,常量通常用于ajax请求url,和一些不会改变的数据

      命名规范:使用大些字母和下划线来组合命名,下划线用以分割单词

      3.函数:小驼峰式命名法

      命名规范:前缀应当为动词

      命名建议:可使用常见动词约定

     栗子:

        

    4.类 & 构造函数

      命名方法:大驼峰式命名法,首字母大写。

      命名规范:前缀为名称。

    5.类的成员

      公共属性和方法:跟变量和函数的命名一样

      私有属性和方法:前缀为_(下划线),后面跟公共属性和方法一样的命名方式

    6.注释规范

      说明:行内注释两个斜杆开始,行尾结束

      语法:code  //这个是行内注释

      使用方式://与代码之间一个空格 与 注释文字之间一个空格

      命名建议:

        // 用来显示一个解释的评论

        // -> 用来显示表达式的结果

        // > 用来显示console的输出结果

      多行注释:/**/

      函数(方法)注释:

       说明:函数(方法)注释也是多行注释的一种,但是包含了特殊的注释要求,参照JSDoc

      

      1.不要保存this的引用,使用Function#bind

      2.给函数命名,这在做堆栈轨迹时很有帮助。

      3.如果你的文件到处一个类,你的文件名应该和类名完全相同。

  4.模块

    模块应该以 ! 开始。这样确保了当一个不好的模块忘记包含最后的分号时,在合并代码到生产环境后不会产生错误。详细说明

    文件应该以驼峰式命名,并放在同名的文件夹里,且与导出的名字一致  

    增加一个名为 noConflict() 的方法来设置导出的模块为前一个版本并返回它。

    永远在模块顶部声明 'use strict';。

  5.构造函数

    给对象原型分配方法,而不是使用一个新对象覆盖原型。覆盖原型将导致继承出现问题:重设原型将覆盖原有原型!

    方法可以返回 this 来实现方法链式使用。

摘自:https://www.cnblogs.com/Hsong/p/9016950.html


免责声明!

本站转载的文章为个人学习借鉴使用,本站对版权不负任何法律责任。如果侵犯了您的隐私权益,请联系本站邮箱yoyou2525@163.com删除。



 
粤ICP备18138465号  © 2018-2025 CODEPRJ.COM