编写可维护的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 收纳架的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!


原文地址:https://blog.csdn.net/weixin_30390075/article/details/96991911
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.chinasem.cn/article/368796

相关文章

SpringBoot集成P6Spy的实现示例

《SpringBoot集成P6Spy的实现示例》本文主要介绍了SpringBoot集成P6Spy的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面... 目录本节目标P6Spy简介抛出问题集成P6Spy1. SpringBoot三板斧之加入依赖2. 修改

Spring Integration Redis 使用示例详解

《SpringIntegrationRedis使用示例详解》本文给大家介绍SpringIntegrationRedis的配置与使用,涵盖依赖添加、Redis连接设置、分布式锁实现、消息通道配置及... 目录一、依赖配置1.1 Maven 依赖1.2 Gradle 依赖二、Redis 连接配置2.1 配置 R

Spring Security重写AuthenticationManager实现账号密码登录或者手机号码登录

《SpringSecurity重写AuthenticationManager实现账号密码登录或者手机号码登录》本文主要介绍了SpringSecurity重写AuthenticationManage... 目录一、创建自定义认证提供者CustomAuthenticationProvider二、创建认证业务Us

Java Stream流以及常用方法操作实例

《JavaStream流以及常用方法操作实例》Stream是对Java中集合的一种增强方式,使用它可以将集合的处理过程变得更加简洁、高效和易读,:本文主要介绍JavaStream流以及常用方法... 目录一、Stream流是什么?二、stream的操作2.1、stream流创建2.2、stream的使用2.

Java对接MQTT协议的完整实现示例代码

《Java对接MQTT协议的完整实现示例代码》MQTT是一个基于客户端-服务器的消息发布/订阅传输协议,MQTT协议是轻量、简单、开放和易于实现的,这些特点使它适用范围非常广泛,:本文主要介绍Ja... 目录前言前置依赖1. MQTT配置类代码解析1.1 MQTT客户端工厂1.2 MQTT消息订阅适配器1.

Spring Boot项目如何使用外部application.yml配置文件启动JAR包

《SpringBoot项目如何使用外部application.yml配置文件启动JAR包》文章介绍了SpringBoot项目通过指定外部application.yml配置文件启动JAR包的方法,包括... 目录Spring Boot项目中使用外部application.yml配置文件启动JAR包一、基本原理

SpringBoot加载profile全面解析

《SpringBoot加载profile全面解析》SpringBoot的Profile机制通过多配置文件和注解实现环境隔离,支持开发、测试、生产等不同环境的灵活配置切换,无需修改代码,关键点包括配置文... 目录题目详细答案什么是 Profile配置 Profile使用application-{profil

Java中InputStream重复使用问题的几种解决方案

《Java中InputStream重复使用问题的几种解决方案》在Java开发中,InputStream是用于读取字节流的类,在许多场景下,我们可能需要重复读取InputStream中的数据,这篇文章主... 目录前言1. 使用mark()和reset()方法(适用于支持标记的流)2. 将流内容缓存到字节数组

Java慢查询排查与性能调优完整实战指南

《Java慢查询排查与性能调优完整实战指南》Java调优是一个广泛的话题,它涵盖了代码优化、内存管理、并发处理等多个方面,:本文主要介绍Java慢查询排查与性能调优的相关资料,文中通过代码介绍的非... 目录1. 事故全景:从告警到定位1.1 事故时间线1.2 关键指标异常1.3 排查工具链2. 深度剖析:

Springboot项目登录校验功能实现

《Springboot项目登录校验功能实现》本文介绍了Web登录校验的重要性,对比了Cookie、Session和JWT三种会话技术,分析其优缺点,并讲解了过滤器与拦截器的统一拦截方案,推荐使用JWT... 目录引言一、登录校验的基本概念二、HTTP协议的无状态性三、会话跟android踪技术1. Cook