语义化 JavaScript 代码

语义化这个词在 HTML 中用的比较多,即根据内容的结构化选择合适的标签。其作用不容小觑:

  • 赋予标签含义,让代码结构更加清晰,虽然我们可以在标签上添加 class 来标识,但这种通过属性来表示本体的形式会显得不够直接,而且在一定程度上也有冗余。
  • 优化搜索引擎(SEO),结构良好的网页对搜索引擎的亲和力是很高的,百度和 google 也给出了很多网页结构化的建议(规范),方便他们抓取网页。
  • 利于设备解析,如盲人阅读器对页面的分析,目前淘宝很多网页都是支持盲人阅读的,这种体验上的优化得利于网页的良好结构和语义化表达。
  • 便于开发者维护,在参加工作之前,很多程序员都是单人开发模式,单人开发无所谓代码结构,自己看得懂就差不多了,一旦走向工作岗位,会发现,以前的鄙习有点让自己捉襟见肘了。

W3C Group 工作组在 web 规范上持续贡献,他们的目标也是期望整个互联网的发展态势稳定统一起来。不扯远了,回到本文需要阐述的重点:如何语义化 JavaScript 代码?

一、先看看那些不易读懂的 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"] 这样是否显得有些不太直观。

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

二、提高代码语义性

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

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(o){
   repos[o.name] = o;
}

register({
  name: “a”,
  content: {}
});

对比我们之前

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

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

三、小结

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

  • 正确标记变量
  • 封装某个动作
  • 注意函数的写法
  • 不容易理解的东西,加注释
时间: 2024-10-27 05:05:42

语义化 JavaScript 代码的相关文章

最小化JavaScript代码

1.去除不必要的格式符.空白符.凝视符. 这个操作.事实上能够理解为是一种格式化.尽管它操作的结果事实上是去除掉原始文件的那些格式. 2.模糊(Obfuscation)处理JAVASCRIP脚本源码. 压缩JS的工具: JSMin :这个工具的名气较大.能够对JAVASCRIPT进行最小化处理

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

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

什么是语义化?

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

HTML标签的语义化

标签的语义化就是指标签的含义.标签为什么要使用语义化的定义呢?是为了使我们的网站更好的被搜索引擎收录. 下面是一个例子 <table> <tr> <td>单价</td> <td>数量</td> </tr> <tr> <td>5.0</td> <td>1</td> </tr> </table> 上面的代码没有使用语义化,下面是使用语义化的代码

浅谈语义化

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

web语义化理解

含义: Web语义化是指使用语义恰当的标签,使页面有良好的结构,页面元素有含义,能够让人和搜索引擎都容易理解. 为什么要web语义化?如今互联网都到了web2.0的时代了,HTML语言在不断的进化并发挥着越来越重要的地位:而我们制作网页也从当初的table表格嵌套发展到了 div+css,但经常看到这种代码整个网页大量的使用div标签进行分隔页面内容,有的甚至整个页面只有div一 种html标签存在,滥用现象使得网页制作似乎就只剩下了div.首先,人可以通过视觉的划分判断内容的语义,搜索引擎看到

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

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

前端工程师必须要知道的SEO技巧(2):制作比设计还要漂亮的代码(内容和语义化代码)上

前言:现在的网站设计,大多数不仅仅要求美观,前端代码往往发挥着重要的作用.这意味着很大一部分搜索引擎优化或搜索引擎优化责任应该落在设计师身上.然而,有大量的网页设计师不理解这个问题以及如何在建立一个网站初期就达到是完全的搜寻引擎优化.当然,要达到这个高度,肯定离不开学习.需要花费时间使用. 一.制作比设计还要漂亮的代码(语义化代码)其实就是在适当的位置使用适当的代码. 接下来,我举几个例子就能明白: H1~H6标签多用于标题. UL标签多用于无序列表. OL标签多用于有序列表. DL标签多用于定

如何让你的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",