如何让你的js代码更加语义化

A,不易懂的JavaScript代码

1.判断

// 数据类型判断
if(Object.prototype.toString.call(str) === “[object String]”){
    // doSomething();
};

// 文件类型判断
if(/.*\.css(?=\?|$)/.test(“/path/to/main.css”)){
    // doSomething();
}

2.清空一个队列

var Queue = ["test1","test2","test3"];
//常见方式
Queue.length =0;
Queue =[];

3.注册一个变量

// 注册
var repos = {};

repos[“a”] = {
   name: “a”,
   content: {}
};

repos[“b”] = {
   name: “b”,
   content: {}
};

上面几个例子倒不至于看不懂,程序都特别简单,第一个例子中,我们通过 Object 原型链上的 toString 方法来判断一个变量是否为 string 类型,以及使用正则来判断一个文件是不是 css 文件。代码写起来比较轻松,倘若我们同时需要判断多个对象是否为多个类型中的一种呢?再比如我们需要在一串代码中提取 require 依赖关系呢,是否应该思考下如何组织自己的代码?

在第二个例子中,将数组的长度设置为 0,或者使用空数组来重置这个变量,都是十分常见的方式,但目前的场景是清空一个队列,我们是否可以使用更加语义化的形式来呈现?比如我们只需要清空该队列的前五个和后三个 item 呢?

第三个例子中,变量的注册,把一堆注册放在一起,上面的形式确实也是一目了然,如果 a b c d 等都是分隔穿插在几百行代码之间呢?突然来个 repos["x"] 这样是否显得有些不太直观。

为了说明本文所倡导的思想,上面的几个解释都有些含糊和牵强,请往下看。

B,他高代码语义性

针对上述三个案例,用更加语义化的方式来呈现代码:

1.语义化变量

// 类型判断
function isType(type){
    return function(o){
        return Object.prototype.toString.call(o) === ‘[object ‘ + type + ‘]‘;
    }
}

var isString = isType(“String”);
var isObject = isType("Object");
var isArray = isType("Array");

isString("I‘m Barret Lee.");
isArray([1,2,3]);
isObject({});

我觉得不需要太多的解释,对比

if(Object.prototype.toString.call(str) === “[object String]”){
    // code here...
}

显得清新多了吧。

// 提取常量
var isCss = /.*\.css(?=\?|$)/;
isCss.test(“/path/to/main.css”);

不管 isCss 这个正则代码有多长,当我们看到 isCss 这个单词就可以顾名思义。很多人写正则都不会将正则单独提取出来使用某个有意义的变量去存储,加注释还好,要是不加注释,后续开发者就只能硬着头皮看懂正则去理解代码的含义。

这样的处理,实际上是增加了代码量,不过从工程角度去审视,有助于提高开发效率以及代码的组织性。

2.语义化行为

var Queue = ["test1", "test2", "test3"];
Queue.splice(0, Queue.length);

上面代码具有很强的语义性,从索引为 0 的地方开始,直到队列最后,删除 Queue 中所有的 item。这种写法的扩展性也更好:

Queue.splice(2,4);//删除从索引为2,往后的4个元素

这只是个小例子,有些行为是需要很多代码组合处理的,如果没有很好的组合同一行为的代码,整个结构就显得十分涣散,不利于阅读。

//注册
var repos=[];

function register(){
     repos[o.name] = o;
}

register({
    name:"a",
    content;{}
});

对比我们之前

repos["a"] ={
    name:"a",
    content;{}
};

语义化程度是不是有所提高

C,小结

代码的优化,需要考虑的维度很多。但是代码的优化并不是减少代码量,有的时候我们需要增加代码来提高代码的可阅读性。

  • 正确标记变量
  • 封装某个动作
  • 注意函数的写法
  • 不容易理解的东西,加注释

本文为抛砖引玉,希望可以触发你对代码优化的敏感度的思考,写出一手别人竖拇指的代码~

时间: 2024-10-21 21:21:47

如何让你的js代码更加语义化的相关文章

如何让你的JavaScript代码更加语义化

语义化这个词在 HTML 中用的比较多,即根据内容的结构化选择合适的标签.起作用不容小觑: 赋予标签含义,让代码结构更加清晰,虽然我们可以在标签上添加 class 来标识,但这种通过属性来表示本体的形式会显得不够直接,而且在一定程度上也有冗余. 优化搜索引擎(SEO),结构良好的网页对搜索引擎的亲和力是很高的,百度和 google 也给出了很多网页结构化的建议(规范),方便他们抓取网页. 利于设备解析,如盲人阅读器对页面的分析,目前淘宝很多网页都是支持盲人阅读的,这种体验上的优化得利于网页的良好

前端与编译原理 用js去运行js代码 js2run

# 前端与编译原理 用js去运行js代码 js2run 前端与编译原理似乎相隔甚远,各种热门的框架都学不过来,那能顾及到这么多底层呢,前端开发者们似乎对编译原理的影响仅仅是"抽象语法树",但这只是个开头而已,我们的目的是利用js直接运行js代码 项目地址 安装及使用方法 写这个干嘛,有现成的eval不香么 接触过微信小程序开发的同学或许知道,小程序为运行环境禁止new Function,eval,setTimeout等方法的使用,限制了我们执行字符串形式的动态代码,其他小程序平台对此也

大多数前端工程师了解但并不擅长的HTML语义化

下面两段代码从HTML语义化的角度来看有什么问题? <!-- more --> <!-- 示例1 --> <label>作者: <input type="author" texture="deep pile"></label> <!-- 示例2 --> <body> <h1>[深度]扒开V8引擎的源码,我找到了你们想要的前端算法</h1> <h2>

什么是语义化?

什么是语义化? 为什么我们提倡书写语义化的代码? ① 语义化的代码,结构清晰,具有良好的可读性,利于维护. 试想一下,当你回顾几个月前甚至是几年前写的代码,如果结构混乱,那重新梳理的过程是十分麻烦,效率十分低下的:当你接手别人写的代码.阅读别人写的代码的时候,如果他的代码没有很好的按照语义化的标准,那么,面对这一大片由各种字符组合成的.编译器识别良好的代码,在你的眼里,就不是那么容易的梳理了,浪费时间.效率低下. 语义化的代码,不仅机器能够识别,对人也友好,不仅能够方便代码的阅读,对代码的后期维

浅谈语义化

什么是语义化? 为什么我们提倡书写语义化的代码? ① 语义化的代码,结构清晰,具有良好的可读性,利于维护. 试想一下,当你回顾几个月前甚至是几年前写的代码,如果结构混乱,那重新梳理的过程是十分麻烦,效率十分低下的:当你接手别人写的代码.阅读别人写的代码的时候,如果他的代码没有很好的按照语义化的标准,那么,面对这一大片由各种字符组合成的.编译器识别良好的代码,在你的眼里,就不是那么容易的梳理了,浪费时间.效率低下. 语义化的代码,不仅机器能够识别,对人也友好,不仅能够方便代码的阅读,对代码的后期维

语义化标签的实战意义

我收集到一些观点,大家姑且先听上一听,有人说:“没必要考虑语义化,只要我写的代码浏览器运行后没问题就行,反正领导根本不关心这些”“语义化是w3c推广的,我是很想语义化我的代码,但总是用不明白”“这个不好说,语义化再好有啥用,关键是有好的项目,客户才是金主!”“除了专业人士,谁会去看我们的代码是不是语义化的” 不仅仅有页面重构人员的声音,也听一听工程师.设计师.还有项目管理人员,他们是怎么看“语义化”这件事的 Php工程师:“无所谓什么语义化,只要逻辑正确,不影响我循环数据”项目管理人员:“我更看

前端CSS和JS代码风格规范

1:不要轻易改动全站级CSS和通用CSS库.改动后,要经过全面测试. 2:css的id,class 名称 语义化,   以 - 相连,   命名少用缩写(除一些所有人一看便知的缩写); 3: Javascript命名规则 3.1:私有变量名用下划线开头; eg: _this = $(this); 3.2:变量名--驼峰命名法; eg: regEmail; 3.3:格式化对象参数;   eg: $.ajax({ type : 'post', url : '/auth/sendCode', data

JavaScript必备:Google发布的JS代码规范(转)

[翻译]关于Google发布的JS代码规范,你需要了解什么? 翻译 | WhiteYin 译文 | https://github.com/WhiteYin/translation/issues/10 Google为了那些还不熟悉代码规范的人发布了一个JS代码规范.其中列出了编写简洁易懂的代码所应该做的最佳实践. 代码规范并不是一种编写正确JavaScript代码的规则,而是为了保持源代码编写模式一致的一种选择.对于JavaScript语言尤其如此,因为它灵活并且约束较少,允许开发者使用许多不同的

20行js代码制作网页刮刮乐

分享一段用canvas和JS制作刮刮乐的代码,JS部分去掉注释不到20行代码效果如下 盖伦.jpg 刮刮乐.gif HTML部分 <body> ![](img/gailun.jpg) <canvas id="canvas" width="400" height="300"></canvas> </body> 没什么要特别注意的为了效果加了些CSS样式 CSS部分 <style type=&qu