JavaScript程序编码规范[译]
作者：cloudwater 发布时间：2009-07-20 17:54:00
这是一套适用于JavaScript程序的编码规范。它基于Sun的Java程序编码规范。但进行了大幅度的修改, 因为JavaScript不是Java。
软件的长期价值直接源于其编码质量。在它的整个生命周期里,一个程序可能会被许多人阅读或修改。如果一个程序可以清晰的展现出它的结构和特征,那就能减少在以后对其进行修改时出错的可能性。
编程规范可以帮助程序员们增加程序的健壮性。
所有的JavaScript代码都是暴露给公众的。所以我们更应该保证其质量。
保持整洁很重要。
JavaScript文件
JavaScript程序应独立保存在后缀名为.js的文件中。
JavaScript代码不应该被包含在HTML文件中,除非这是段特定只属于此部分的代码。在HTML中的JavaScript代码会明显增加文件大小,而且也不能对其进行缓存和压缩。
filename.js>应尽量放到body的后面。这样可以减少因为载入script而造成其他页面内容载入也被延迟的问题。也没有必要使用 language或者type属性。MIME类型是由服务器而非scripttag来决定的。
缩进
缩进的单位为四个空格。避免使用Tab键来缩进(即使现在已经是21世纪了),也始终没有个统一的Tab长短标准。虽然使用空格会增加文件的大小,但在局域网中几乎可以忽略,且在 最小化过程中也可被消除掉。
每行长度
避免每行超过80个字符。当一条语句一行写不下时,请考虑折行。在运算符号,最好是逗号后换行。在运算符后换行可以减少因为复制粘贴产生的错误被分号掩盖的几率。下一行应该缩进8个空格。
注释
不要吝啬注释。给以后需要理解你的代码的人们(或许就是你自己)留下信息是非常有用的。注释应该和它们所注释的代码一样是书写良好且清晰明了。偶尔的小幽默就更不错了。记得要避免冗长或者情绪化。
及时地更新注释也很重要。错误的注释会让程序更加难以阅读和理解。
让注释有意义。重点在解释那些不容易立即明白的逻辑上。不要把读者的时间浪费在阅读类似于:
i = 0; //让i等于0
使用单行注释。块注释用于注释正式文档和无用代码。
变量声明
所有的变量必须在使用前进行声明。JavaScript并不强制必须这么做,但是这么做可以让程序易于阅读,且也容易发现那些没声明的变量(它们会被编译成全局变量)。
将var语句放在函数的首部。
最好把每个变量的声明语句单独放到一行,并加上注释说明。所有变量按照字母排序。
var currentEntry; // 当前选择项
var level; // 缩进程度
var size; // 表格大小
JavaScript没有块范围,所以在块里面定义变量很容易引起C/C++/Java程序员们的误解。在函数的首部定义所有的变量。
尽量减少全局变量的使用。不要让局部变量覆盖全局变量。
0
投稿猜你喜欢
目录range函数的使用第一种创建方式第二种创建方式第三种创建方式判断指定的数有没有在当前序列中循环结构总结range函数的使用作为循环遍历- 关于“登录”和“注册”的问题已经被很多设计师和交互设计上写过无数遍了，今天我在登录纳米盘网站时受到打击了所以写下此文。事情是这样的：当初租用
- 目录1、准备基础数据2、一次性展示数据3、引入分页器附:drf分页器的使用1.1 PageNumberPagination1.2 Limit
- 在《多线程与同步》中介绍了多线程及存在的问题，而通过使用多进程而非线程可有效地绕过全局解释器锁。 因此，通过multiprocessing模
- 1.预备知识python语言，scrapy爬虫基础，json模块，flask后端2.抓取CSDN数据接口使用谷歌抓包工具抓取CSDN搜索引擎
- 最近遇到SQL Server 2005 输入框不能输入中文，在网上查了N久，试验了十几次奏这个法子有用：“把你表中的自动编号列放到最后面”。
- 女朋友是一个软件测试人员，在工作中经常会遇到需要录屏记录自己操作，方便后续开发同学定位。因为录屏软件动不动就开始收费，所以她经常更换录屏软件
- 操作步骤导入框架，import unitest测试类必须继承类：.class 类名(unittest.TestCase):在类中所有定义te
- 在一个页面制作过程，突然被设计稿上的一个问题难住了，思路一时没打开，后来在费人的提醒下，用定位控制，顺利完成。这个是我做的大概的
- 数据库：30万条，有ID列但无主键，在要搜索的“分类”字段上建有非聚集索引过程T-SQL： /* 用户自定义函数：执行时间在115
- 原文地址https://www.codementor.io/python/tutorial/advanced-use-python-deco
- 一、命名元祖在python基础中， 我们学习元祖的时候，取元祖内部的元素都是通过索引来进行取值的。但是这种取值方式不够友好， 所以我们引入命
- python装饰器就是用于扩展原函数功能的一种函数，这个函数特殊的地方就是它的返回值也是一个函数，使用Python装饰器的一个好处就是：在不
- JOIN对于接触过数据库的人，这个词都不陌生，而且很多人很清楚各种JOIN，还有很多人对这个理解也不是很透彻。假设我们有两个表，Table_
- 安装时建议你为MySQL管理创建一个用户和组。由该组用户运行mysql服务器并执行管理任务。（也可以以root身份运行服务器，但是不推荐）第
- 本文将以Mysql举例，介绍sqlalchemy的基本用法。其中，Python版本为2.7，sqlalchemy版本为1.1.6。一. 介绍
- 最近看JavaScript高级程序设计，大有收获，接下来几天写一下读书笔记。之前写了一篇Ajax初步理解的随笔，里面有个函数用来创建XmlH
- 写了一段时间java切回写python偶尔会出现一些小麻烦，比如：在java中自定义对象变成json串很简单，调用一个方法就行，但同样的转换
- 多态问起面向对象的三大特性，几乎每个人都能对答如流：封装、继承、多态。今天我们就要来说一说 Python 中的多态。所谓多态：就是指一个类实
- 这篇文章主要介绍了Python中的四种交换数值的方法解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的
