编写可维护的JavaScript 收纳架

2023-11-08 08:20
文章标签 java 编写 script 维护 收纳

本文主要是介绍编写可维护的JavaScript 收纳架,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

  如果你看过Nicolas C.Zakas写过的任何作品,你必须承认他是个不折不扣的天才。也只有天才级的才能写出《JavaScript高级程序设计》让所有的前端攻城师人手一本。Nicolas C.Zakas除了对现代JavaScrpt技术的详细讲解,还倡导了很多最佳实践,包括渐进增强、可访问性、性能、扩展性和可维护性等。

  编写可维护的Javascript就意味着:消灭团队个体的差异达成整体的统一,以保持大家的代码风格一致和可读的、可维护性的、可扩展的。所以该系列收纳架做一个收纳整理。

 

  书从编码风格、编程实践以及自动化3个部分来讲。

第一部分 编程风格

  编程风格的确定会促成整个团队成员的高水准运作,因为所有的代码风格看起来极为类似就如同一个人编写。

在团队开发中,编程风格一致性变得尤为重要,原因有:

  • 任何开发者都不在乎某个文件的作者是谁,也没有必要花费额外的精力去理解代码的逻辑并且重新排版,因为所有代码的排版风格都是非常一致的,因为风格不一致会导致我们打开代码文件的第一件事情不是立即工作,而是进行缩进的排版整理。
  • 能很容易的辨别出有问题的代码并且发现错误,如果所有的代码风格很像,当看到一段与众不同的代码时,很肯能问题就出在这里。

  JSLint 和 JSHint 是两个检查编程风格的工作。不仅找出代码中潜在的错误,还能对潜在的风格问题给予提示警告。JSLint是属于“顽固派”不接受你的自定义也就是不会为你做任何改变;JSHint是属于“受教派”可以接受你的自定义个性化的检查。

第一章 基本的格式化

  编程风格的核心就是基本的格式化规范,这些规范决定着如何编写高水准的代码。

1.1 缩进层级

  缩进没有统一的共识二分成两派:

  • 使用制表符缩进。  
  • 使用空格缩进。
只要不将两者混着用,保持一致便可。个人喜欢使用制表符Tab缩进。Zakas建议4个空格,或设置 制表符Tab 替换为 4个空格为一个缩进层。
1.2 语句结尾
由于JavaScript分析器会自动插入机制,所以禁止省略分号和函数中的前“{”不应该换行。
如:
// 原始代码
function getData() {return{title:"JavaScript",...}
}// 分析器将理解成
function getData() {return;{title:"JavaScript",...}
}// 推荐写法
function getData() {return {title:"JavaScript",...}
}
View Code

 

1.3 行的长度

  行的长度不应该超过80个字符。

1.4 换行

  当一行达到了单行最大字符数或超过单屏时,应该手动换行。推荐在运算符后换行,下一行需增加两个层级的缩进(两个Tab/8个字符)]

1.5 空行

  空行推荐使用在:

  • 在每个流控制语句之前(如if/for等)。
  • 在方法之间。
  • 在方法中局部变量和第一条语句之间。
  • 在多行或单行注释之前。
  • 在方法内的逻辑片段之间插入空行,提供可读性。
  • 在一段代码的语义和另一段代码不相关之间,确保语义有关联的代码展现在一起 如:
// 不推荐写法
if(wl && wl.length){for (i=0,l=wl.length;i<l;++i) {...}
}// 推荐写法
if(wl && wl.length){for (i=0,l=wl.length;i<l;++i) {...}
}
View Code

1.6 命名

  JavaScripe 核心 ECMAScript,即是遵照了驼峰式大小写。

  1.6.1 变量和函数

    变量名总是应该遵循驼峰大小写命名法,并且命名的前缀应当是名词,使得可以将变量和函数区分开。 如:

// 不推荐写法: 变量看起来像函数
var getCount=10;
var isFound=true;// 推荐写法
var count=10;
var found=true;
View Code

    命名长度尽可能短并能看词知意。

    常见参考:

can        函数返回布尔值
has       函数返回布尔值
is          函数返回布尔值
get        函数返回非布尔值
set        函数用来保存值
1.6.2 常量
在ECMAScript 6 之前,JavaSCript 不存在真正的常量的概念。然后工作中仍然把变量用作成常量的。由于我是用C#的,如果根据C#的命名规则,约定常量首字母大写来区分, 如:
// 这是我的个人约定跟本书不同(书是C语言使用大写字母和下划线命名)
var MaxCount=100;
var Url="http://www.cnblogs.com/";
View Code

 

  1.6.3 构造函数

    构造函数的命名是遵照 UpperCamelCase(大驼峰)命名法。

 

1.7 直接量

                                                                                          《-未完 待续-》

转载于:https://www.cnblogs.com/chehaoj/p/3362583.html

这篇关于编写可维护的JavaScript 收纳架的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/368796

相关文章

Java实现检查多个时间段是否有重合

《Java实现检查多个时间段是否有重合》这篇文章主要为大家详细介绍了如何使用Java实现检查多个时间段是否有重合,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录流程概述步骤详解China编程步骤1:定义时间段类步骤2:添加时间段步骤3:检查时间段是否有重合步骤4:输出结果示例代码结语作

Java中String字符串使用避坑指南

《Java中String字符串使用避坑指南》Java中的String字符串是我们日常编程中用得最多的类之一,看似简单的String使用,却隐藏着不少“坑”,如果不注意,可能会导致性能问题、意外的错误容... 目录8个避坑点如下:1. 字符串的不可变性:每次修改都创建新对象2. 使用 == 比较字符串,陷阱满

Java判断多个时间段是否重合的方法小结

《Java判断多个时间段是否重合的方法小结》这篇文章主要为大家详细介绍了Java中判断多个时间段是否重合的方法,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录判断多个时间段是否有间隔判断时间段集合是否与某时间段重合判断多个时间段是否有间隔实体类内容public class D

IDEA编译报错“java: 常量字符串过长”的原因及解决方法

《IDEA编译报错“java:常量字符串过长”的原因及解决方法》今天在开发过程中,由于尝试将一个文件的Base64字符串设置为常量,结果导致IDEA编译的时候出现了如下报错java:常量字符串过长,... 目录一、问题描述二、问题原因2.1 理论角度2.2 源码角度三、解决方案解决方案①:StringBui

Java覆盖第三方jar包中的某一个类的实现方法

《Java覆盖第三方jar包中的某一个类的实现方法》在我们日常的开发中,经常需要使用第三方的jar包,有时候我们会发现第三方的jar包中的某一个类有问题,或者我们需要定制化修改其中的逻辑,那么应该如何... 目录一、需求描述二、示例描述三、操作步骤四、验证结果五、实现原理一、需求描述需求描述如下:需要在

Java中ArrayList和LinkedList有什么区别举例详解

《Java中ArrayList和LinkedList有什么区别举例详解》:本文主要介绍Java中ArrayList和LinkedList区别的相关资料,包括数据结构特性、核心操作性能、内存与GC影... 目录一、底层数据结构二、核心操作性能对比三、内存与 GC 影响四、扩容机制五、线程安全与并发方案六、工程

JavaScript中的reduce方法执行过程、使用场景及进阶用法

《JavaScript中的reduce方法执行过程、使用场景及进阶用法》:本文主要介绍JavaScript中的reduce方法执行过程、使用场景及进阶用法的相关资料,reduce是JavaScri... 目录1. 什么是reduce2. reduce语法2.1 语法2.2 参数说明3. reduce执行过程

如何使用Java实现请求deepseek

《如何使用Java实现请求deepseek》这篇文章主要为大家详细介绍了如何使用Java实现请求deepseek功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1.deepseek的api创建2.Java实现请求deepseek2.1 pom文件2.2 json转化文件2.2

Java调用DeepSeek API的最佳实践及详细代码示例

《Java调用DeepSeekAPI的最佳实践及详细代码示例》:本文主要介绍如何使用Java调用DeepSeekAPI,包括获取API密钥、添加HTTP客户端依赖、创建HTTP请求、处理响应、... 目录1. 获取API密钥2. 添加HTTP客户端依赖3. 创建HTTP请求4. 处理响应5. 错误处理6.

Spring AI集成DeepSeek的详细步骤

《SpringAI集成DeepSeek的详细步骤》DeepSeek作为一款卓越的国产AI模型,越来越多的公司考虑在自己的应用中集成,对于Java应用来说,我们可以借助SpringAI集成DeepSe... 目录DeepSeek 介绍Spring AI 是什么?1、环境准备2、构建项目2.1、pom依赖2.2