zoukankan      html  css  js  c++  java
  • 命名规范

    一、命名规范

    驼峰式命名法介绍:

    驼峰式命名法由小(大)写字母开始,后续每个单词首字母都大写。

    按照第一个字母是否大写,分为:

         ① Pascal Case 大驼峰式命名法:首字母大写。eg:StudentInfo、UserInfo、ProductInfo

         ② Camel Case 小驼峰式命名法:首字母小写。eg:studentInfo、userInfo、productInfo

    1.1 变量

    命名方法:小驼峰式命名法。

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

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

    示例:

    1
    2
    3
    4
    5
    6
    7
    // 好的命名方式
    var maxCount = 10;
    var tableTitle = 'LoginTable';
      
    // 不好的命名方式
    var setCount = 10;
    var getTitle = 'LoginTable';

    1.2 函数

    命名方法:小驼峰式命名法。

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

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

      动词   含义 返回值
    can 判断是否可执行某个动作(权限) 函数返回一个布尔值。true:可执行;false:不可执行
    has 判断是否含有某个值 函数返回一个布尔值。true:含有此值;false:不含有此值
    is 判断是否为某个值 函数返回一个布尔值。true:为某个值;false:不为某个值
    get 获取某个值 函数返回一个非布尔值
    set 设置某个值 无返回值、返回是否设置成功或者返回链式对象
    load 加载某些数据 无返回值或者返回是否加载完成的结果

    示例:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    // 是否可阅读
    function canRead() {
     return true;
    }
      
    // 获取名称
    function getName() {
     return this.name;
    }

    1.3 常量

    命名方法:名称全部大写。

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

    命名建议:无。

    示例:

    1
    2
    var MAX_COUNT = 10;

    1.4 构造函数

    介绍:在JS中,构造函数也属于函数的一种,只不过采用new 运算符创建对象。

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

    命名规范:前缀为名称。

    命名建议:无。

    示例:

    1
    2
    3
    4
    5
    function Student(name) {
     this.name = name;
    }
      
    var st = new Student('tom');

    1.5 类的成员

    类的成员包含:

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

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

    示例:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    function Student(name) {
     var _name = name; // 私有成员
      
     // 公共方法
     this.getName = function () {
     return _name;
     }
      
     // 公共方式
     this.setName = function (value) {
     _name = value;
     }
    }
    var st = new Student('tom');
    st.setName('jerry');
    console.log(st.getName()); // => jerry:输出_name私有变量的值
     

    1.6、组件规范

    1. 组件名命名规范

    ①、组件在使用时命名以 " x- " 为开头的组件名,若组件名称为多个单词名拼接而成,采用 " - " 连接.②、组件标签在 page 页面使用时推荐使用单闭合标签,包含 slot的组件除外2. 触发事件规范

    组件点击触发事件建议用冒号分隔开

    3. externalClasses 命名规范

    命名格式采用如下形式: x-class-{name}

    4. 组件样式规范

    命名必须以 x- 开头

    1.7、标点规范

    1、JS 中一致使用反引号 ` 或单引号 ‘’ , 不使用双引号2、WXML CSS JSON 中均应使用双引号。

     
    二、 注释规范

    JS支持两种不同类型的注释:单行注释和多行注释。

    2.1 单行注释

    说明:单行注释以两个斜线开始,以行尾结束。

    语法:// 这是单行注释

    使用方式:

          ① 单独一行://(双斜线)与注释文字之间保留一个空格。

          ② 在代码后面添加注释://(双斜线)与代码之间保留一个空格,并且//(双斜线)与注释文字之间保留一个空格。

          ③ 注释代码://(双斜线)与代码之间保留一个空格。

    示例:

    1
    2
    3
    4
    5
    6
    // 调用了一个函数;1)单独在一行
    setTitle();
      
    var maxCount = 10; // 设置最大量;2)在代码后面注释
      
    // setName(); // 3)注释代码

    2.2 多行注释

    说明:以/*开头,*/结尾

    语法:/* 注释说明 */

    使用方法:

          ① 若开始(/*)和结束(*/)都在一行,推荐采用单行注释。

          ② 若至少三行注释时,第一行为/*,最后行为*/,其他行以*开始,并且注释文字与*保留一个空格。

    示例:

    1
    2
    3
    4
    5
    /*
    * 代码执行到这里后会调用setTitle()函数
    * setTitle():设置title的值
    */
    setTitle();

    2.3 函数(方法)注释

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

    语法:

    1
    2
    3
    4
    /**
    * 函数说明
    * @关键字
    */

    常用注释关键字:(只列出一部分,并不是全部)

    注释名 语法 含义 示例
    @param @param 参数名 {参数类型}  描述信息 描述参数的信息 @param name {String} 传入名称
    @return @return {返回类型} 描述信息 描述返回值的信息 @return {Boolean} true:可执行;false:不可执行
    @author @author 作者信息 [附属信息:如邮箱、日期] 描述此函数作者的信息 @author 张三 2015/07/21 
    @version @version XX.XX.XX 描述此函数的版本号 @version 1.0.3
    @example @example 示例代码 演示函数的使用 @example setTitle('测试')

    示例:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    /**
    * 合并Grid的行
    * @param grid {Ext.Grid.Panel} 需要合并的Grid
    * @param cols {Array} 需要合并列的Index(序号)数组;从0开始计数,序号也包含。
    * @param isAllSome {Boolean} :是否2个tr的cols必须完成一样才能进行合并。true:完成一样;false(默认):不完全一样
    * @return void
    * @author polk6 2015/07/21
    * @example
    * _________________ _________________
    * | 年龄 | 姓名 | | 年龄 | 姓名 |
    * ----------------- mergeCells(grid,[0]) -----------------
    * | 18 | 张三 | => | | 张三 |
    * ----------------- - 18 ---------
    * | 18 | 王五 | | | 王五 |
    * ----------------- -----------------
    */
    function mergeCells(grid, cols, isAllSome) {
     // Do Something
    }

     

  • 相关阅读:
    内存中的堆和栈
    数据库——关系型数据库
    如何创建一个进程,如何进程调用进程
    浅谈C++之冒泡排序、希尔排序、快速排序、插入排序、堆排序、基数排序性能对比分析(好戏在后面,有图有真相)
    Moon.Orm 5.0(MQL版)使用指南
    初学 快速幂 的理解
    2016 杭电
    2015 偶数求和 AC 杭电
    2014 青年歌手大赛 AC
    C语言初学 数组 打印菱形
  • 原文地址:https://www.cnblogs.com/zhangzhaowei/p/14578305.html
Copyright © 2011-2022 走看看