JavaScript 函数和变量的命名规则

变量和函数

    变量名应该总是遵循驼峰大小命名写法,并且命名前缀应当是名词。以名词作为前缀可以让变量和函数区分开来,因为函数名前缀应当是动词。

//    好的写法

var count = 10;

var myName = “Nichlas”;

var found = true;

//    不好的写法:变量看起来像函数

var getcount = 10;

var isFound = true;

//    好的写法

functiongetName() {

        return myName;

}

//   不好的写法:函数看起来像变量

function theName() {

        return myName;

}

        总结:尽量在变量名中体现出值得数据类型。比如:,命名    count、length、size和page表明数据类型是数字,而命名    name、title、和message 表明数据类型是字符串。


函数命名方法:

        对于函数的方法命名来说,第一个单词应该是动词。


                    动词                                                                含义


                    can                                                       函数返回一个布尔值


                    has                                                       函数返回一个布尔值


                    is                                                          函数返回一个布尔值


                    get                                                        函数返回一个非布尔值


                    set                                                        函数用来保存一个值


示列:

    if (isEnabled()){

            setName("Nicholas");  

  }   

 if(getName() === "Nicholas") { 

          doSomething();  

  }


null:

        null是一个特殊值,但我们常常误解它,将它和undefined搞混。在下列场景中应当使用null。

●    用来初始化一个变量,这个变量可能赋值为一个对象。

●    用来和一个已经初始化的变量比较,这个变量可以是也可以不是一个对象。

●     当函数的参数期望对象时,用作返回值传入。

●    当函数的返回值期望是对象时,用作返回值传出。



还有下面一些场景不应当使用null

●    不要使用null来检测是否传入了某个参数。

●    不要用null来检测一个未初始化的变量。


示列代码:

// 好的方法

var person  = null;

//好的方法

function getPerson(){ 

      if(condition){ 

               return    new Person(“Nicholas”);

        } else {

                return null;

        }

}

//    好的方法

var person = getPerson();

if(person !== null){ 

      doSomething();

}

// 不好的写法:用来和未初始化的变量比较

var person;

if(person != null) { 

      doSomething();

}

 // 不好的写法:检测是否传入参数

function doSomething(arg1,arg2,arg3,arg4){ 

      if(arg4 != null){

                doSomethingElse();

        }

}

        理解null 最好的方式就是将它当做对象的占位符(placeholder)。这个规则在所有的主流编程规范中都没有提及,但对于全局维护性来说至关重要。


undefined:

        undefined 是一个特殊值,我们通常将它和null搞混。其中一个让人颇为困惑之处在于 null == undefined 结果是true。 然而,这两个值得用途却各不相同。那些没有被初始化的变量都有一个初始值,即 undefined,表示这个变量等待被赋值。

比如:

var  person;

console.log(person === undefined); //true

尽管这段代码能正常运行工作,但我们尽量避免代码中使用undefined。


注释:

        单行注释不应当连续多行注释的形式出现,除非你注释掉一段换代码。只有当需要主是一段很长的文本时才使用多行注释。

示列代码:

// 好的写法

if(condition) {


    // 如果代码执行到这里,则表明通过了所有的安全检查 

  allowed();

}

// 不好的写法:注释之前没有空格

if(condition) {

 // 如果代码执行到这里,则表明通过了所有的安全检查

    allowed();

}


   正确的使用注释:

        何时添加注释是程序员经常争论的一个话题。一种通行的指导原则是,当代吗不够清晰时加注释,而代码很明确了时不应当添加注释。

    //    不好的写法

    //     初始化 count  

          var  count = 10;

        代码中初始化count 的操作显而易见。 如果这个值10具有特殊的意义,通过戴拿无法看出来,这个是有有必要添加注释。

    //    好的写法

    // 改变这个值可能会让它变成青蛙

        var  count = 10;

*    添加注释一般的原则是,在需要让代码变得清晰时添加注释。



最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 151,829评论 1 331
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 64,603评论 1 273
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 101,846评论 0 226
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,600评论 0 191
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,780评论 3 272
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,695评论 1 192
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,136评论 2 293
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,862评论 0 182
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,453评论 0 229
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,942评论 2 233
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,347评论 1 242
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,790评论 2 236
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,293评论 3 221
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,839评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,448评论 0 181
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,564评论 2 249
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,623评论 2 249

推荐阅读更多精彩内容

  • 第2章 基本语法 2.1 概述 基本句法和变量 语句 JavaScript程序的执行单位为行(line),也就是一...
    悟名先生阅读 4,045评论 0 13
  • 前端07班 王语句JavaScript程序的执行单位为行(line),也就是一行一行地执行。一般情况下,每一行就是...
    ea203453e188阅读 852评论 0 4
  • 第3章 基本概念 3.1 语法 3.2 关键字和保留字 3.3 变量 3.4 数据类型 5种简单数据类型:Unde...
    RickCole阅读 5,000评论 0 21
  • 函数和对象 1、函数 1.1 函数概述 函数对于任何一门语言来说都是核心的概念。通过函数可以封装任意多条语句,而且...
    道无虚阅读 4,328评论 0 5
  • 周五。工作得还好,又被怼了,是自己没做好才会给别人批评自己的理由。 然后就是,该好好想想怎么提高速度了。既然做了,...
    小王子的前世今生阅读 81评论 0 0