JavaScript命名规范基础及系统注意事项

前端代码中的自定义变量命名
     
    命名方法:
    1.驼峰 2.下划线连接
     
    对于文件名,我们一般采用小写字母+下划线的形式
    为什么?因为在window下aa.txt和AA.txt系统认为是同一个的文件,而在linux环境下则认为是2个不同的文件,为了使我们代码移植性更好以及为了避免一些不必要的麻烦建议文件名必须小写;
     
    对于js又有以下一些规则:
    A:普通变量名
    1.以变量首字母突出这个变量的类型(我叫她首字母标记类型法);
    如:
    定义多个学生数组 let aStudent = [‘shiyue‘, ‘ansheng‘];
    定义一个学生对象 let oStudent = { name: ‘xx‘ };
    定义学生的名字 let sName = ‘HanMeimei‘;
     
    2.在变量末尾突出这个变量类型(我叫她变量末尾比较类型法, 我自己比较喜欢这种);
    如:
    2.1 驼峰命名
    定义多个学生数组 let studentAry = [‘shiyue‘, ‘ansheng‘];
    定义一个学生对象 let studentObj = { name: ‘xx‘ };
    定义学生的名字 let name = ‘HanMeimei‘;
    2.2 下划线命名
    定义多个学生数组 let student_ary = [‘shiyue‘, ‘ansheng‘];
    定义一个学生对象 let student_obj = { name: ‘xx‘ };
    定义学生的名字 let name = ‘HanMeimei‘;
     
    B: 函数变量名
    函数名推荐采用驼峰命名
    如:
    获取学生姓名的方法: let getName = function(){} ---方式1
    可能有人会这样定义: let getStudentName = function(){} ---方式2
    这2种方式哪个更好呢?
    如果这个脚本或者说这个文件中有获取学生姓名和获取老师姓名2个需求,那我觉得方式2更合适,如果只有获取学生姓名这1个需求,那方式1更简单合适;
     
    获取学生这个对象: let getStudent = function(){}
    因为student就是1个对象,所以我们不需要写成getStudentObj,阅读我们代码的人也能一目了然的想到这是获取学生对象;
     
    C: 事件监听函数命名
    事件监听函数命名建议采用onXXX开头的驼峰式命名
    如:
    监听一个下拉选择组件的change事件: let onSelectChange = function(e){...}
    当一个页面中需要注册多个下拉选择组件的change事件时我们又该如何定义?
    这个时候直接写onSelectChange显然不太合适了,
    如筛选条件中 学生对象的改变; 性别的改变
    onStudentChange(){}
    onSexChange(){}
     
    !important
    D:关于变量名的简写
    很多时候我们的变量名需要多个单词拼接,但是我们又不想让这个变量名太长,很难取舍
    如:
    定义未读消息条数,我看到有人是这样定义的 let notRead = 0;
    显然这个变量很糟糕, 首先否定修饰很多时候只需要在单词前面加上un, 比如我们js中的defined <-> undefined,其次,我们在定义记数相关时一般都会使用count
    let unReadCount = 0; ---方式1
    let notRead = 0; ---方式2
    显然方式1更优雅,一看就知道是个数量的定义,而方式2更像是一个未读的Flag标记,很难让人直接和未读条数联系起来;
     
     
    E: 逻辑关系
    如:
    在vue中定义一个是否显示的标记: v-if="isShow"
    isShow是true就是显示,false就是隐藏,这样我们的代码逻辑就会很清晰;
    现在我们看2个很糟糕的例子:
    同样是在vue中定义是否显示的标记:
    v-if="isHide"
    v-if="!isHide"
    这2中方式都不好,我们的原则就是能避免使用否定的就尽量不要使用否定,不管单个否定还是双向否定,总之正向的逻辑会更清晰;
     
    要洗澡睡觉了,对于css样式的命名下一篇再介绍

原文地址:https://www.cnblogs.com/longly/p/10023760.html

时间: 2024-08-02 03:45:02

JavaScript命名规范基础及系统注意事项的相关文章

CSS命名规范参考及书写注意事项

CSS书写顺序 *{ /*显示属性*/ display position float clear cursor - /*盒模型*/ margin padding width height /*排版*/ vertical-align white-space text-decoration text-align - /*文字*/ color font content /*边框背景 为什么要把 boder和background放在最后的原因是修改的频率会较之前的频繁,放在最后查看起来方便,哈哈.*/ 

javascript命名规范

匈牙利命名法语法: 变量名=类型+对象描述 var aName = ['zhangsan','lizi','zhaowu'];  //Array 数组 var oBtn = window.document.getElementById('btn');  //Object 对象 function fnName(){};  //Function 函数 var nAge = 25;  //Integer(int) 整型 var sWebURL="www.wangyingran.com"; 

JavaScript发展史,与JScript差别,引入方式,数据类型,命名规范,命名推荐,解决命名冲突

文件夹: 1.JavaScript发展史 2.JavaScript与JScript差别 3.JavaScript引入方式 4.JavaScript基本数据类型及布尔值 5.JavaScript命名规范 6.JavaScript命名推荐 7.JavaScript解决命名冲突 1. JavaScript发展史 1.Netscape发明了JavaScript(1992年后) 1)出现JavaScript的原因(Netscape Navigator) * 网络的不断普及与推广,有庞大的用户量 * 因为当

Web UI 网站用户界面设计命名规范

Web UI 网站用户界面设计命名规范 WEB UI设计命名规范,也就是网站用户界面设计(网页设计)命名规范. 这套规范并非单纯的CSS.html或JavaScript命名规范,它涉及了很多使用PhotoShop这类设计工具进行网页设计过程中的命名规范. 许多美工设计效果图源文件没有对图层命名的习惯,而网上大多命名规范都是关于css.html.js和一些服务器端语言的,设计方面的命名规范很 少.设计师也是技术团队的成员,而前端开发工程师需要使用设计师的效果图源文件的,所以统一命名规范和设计规范对

常用html、CSS、javascript前端命名规范

常用html.CSS.javascript前端命名规范 无意发现自己文件夹里面有这么一个文件,具体从哪里来的不记得了,仔细看下,发现总结的挺好的,贴出来分享一下. 无论是从技术角度还是开发视角,对于web前端开发规范文档都有一定规范,本文就css3和html5的发展前景总结了一系列的web开发文档,仅供大家参考. 规范目的: 为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档. 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发. 本

Android 开发 命名规范(基础回顾)

标识符命名法标识符命名法最要有四种: 1 驼峰(Camel)命名法:又称小驼峰命名法,除首单词外,其余所有单词的第一个字母大写. 2 帕斯卡(pascal)命名法:又称大驼峰命名法,所有单词的第一个字母大写 3 下划线命名法:单词与单词间用下划线做间隔. 4 匈牙利命名法:广泛应用于微软编程环境中,在以Pascal命名法的变量前附加小写序列说明该变量的类型. 量的取名方式为:<scope_> + <prefix_> + <qualifier>范围前缀,类型前缀,限定词.

c语言基础数据类型及命名规范

1. 常量是程序运行期间不能被改变的量; 变量代表一个存储区域,存储区域内存储的内容就是变量的值, 变量的值可以在程序运行期间改变  (变量就像一个杯子, 用来存放水, 杯子里的水即变量的值是可以改变的) 2.基本数据类型:int: 整型类型, 在内存中占4个字节, 在计算机中每个字节都由8个二进位制数表示; short: 短整型类型, 在内存中占2个字节 long: 长整型类型, 在内存中占4或8个字节, 和操作系统有关, 在32位的操作系统中占4个字节, 在64位的操作系统中占8个字节 fl

JavaScript发展史,与JScript区别,引入方式,数据类型,命名规范,命名推荐,解决命名冲突

今天真机调试的时候莫名其妙遇到了这样的一个问题: This product type must be built using a provisioning profile, however no provisioning profile matching both the identity "iPhone Developer" and the bundle identifier..... 具体如下图所示: 十分蛋疼, 发现不管是从网上下的demo, 还是自己的过程.凡事真机测试的时候都

JavaScript知识点总结(命名规范,变量的作用域)

命名规范 有人说JavaScript的宽容性是这个语言最糟糕的方面之一.比如说想把2个数字加在一起,JavaScript会把其中一个数字解析成字符串,那么就会得到一个奇怪的字符串,而不是2个数字的和. 说到JavaScript的数据类型的时候,环境就是一切.本文要讲述3种数据类型:字符串类型,布尔型,数字型. JavaScript的变量和其他语言的变量很相似.它们用来保存值,而这些保存了的值,可以在代码的不同的地方被访问到.在其所使用的作用域范围内,每个变量的标识符是一样的.JavaScript