js编码规范

使用统一的 编码规范 编写代码能提高JS代码的可读性,利于后期的维护和扩展,利于团队开发。

引用规范:

1、采用<script>...</script>方式引入 *.js 文件,避免在html中内嵌js代码;

原因在于这样做可以利用 浏览器 的Cache(缓存)避免页面刷新而重新加载,对于JS代码来讲是没有必要的,反而是加大了文件的传输量;

2、js代码采用分多个文件引入的方法,这样可以避免因局部代码修改而引发的重复调用;

命名规范:

原则是:以最少的字母达到最容易理解的意义。

1、变量声明

♦ 所有代码在使用前应将变量声明好,虽然不是必须的,但这样可以使代码易读,并且可以方便找出那些没有声明而被编译为全局的变量;

♦ 将每个变量单独放置一行,并加注释,以变量开头字母排序为序,并采用驼峰命名规范,如下:

var   ageValue,           //年龄值

nameValue,       //姓名值

sexValue            //性别

2、函数声明

所有的函数必须在使用前声明;跟在var变量声明后面声明函数,方便查看变量作用域;

具名函数声明:函数名与左括号 “(” 之间不应该有空格,

右括号“(” 与主体语句大括号 “{” 之间应该有空格

       程序主体应当缩进4个空格,而非一个Tab(Tab占位没有一个统一的标准)

       主体语句结束符号 “}” 与函数声明开始哪一行对齐;

       function fun(str) {

           var m=0;

m=m+str;

}

匿名函数声明:函数名与左括号“(”之间应当有空格,便于阅读;

       function (str) {

           str="hello";

}

3、注释

要将注释写出来;良好的代码注释可以给日后的自已或者读者提供理解代码的捷径。

代码注释不要太冗长或带有个人情绪;

代码注释要有意义,不要写一些根本就不需要写的注释;

注释要跟随代码的修改及时更新,避免误导。

原文章引用地址:http://www.2cto.com/kf/201305/213172.html

时间: 2024-10-16 14:56:27

js编码规范的相关文章

HTML/CSS/JS编码规范

最近整理了一份HTML/CSS/JS编码规范,供大家参考.目录:一.HTML编码规范二.CSS编码规范三.JS编码规范 一.HTML编码规范 1. img标签要写alt属性 根据W3C标准,img标签要写alt属性,如果没有就写一个空的.但是一般要写一个有内容的,根据图片想要表达的意思,因为alt是在图片无法加载时显示的文字.如下不太好的写法: <img src="company-logo.svg" alt="ABC Company Logo"> 更好的

Node.js编码规范

调用函数的时候,函数名与左括号之间没有空格. 函数名与参数序列之间,没有空格:所有其他语法元素与左括号之间,都有一个空格. 使用小驼峰式命名法作为所有变量和属性的命名规则. 缩进使用两空格,统一使用单引号. 关联数组,除非键名中有空格或是非法字符,否则一律不用引号. 不要将不同目的的语句,合并成一行. 不要省略句末的分号,哪怕一行只有一个语句. 不要使用自增(++)和自减(--)运算符,用+=和-=代替. 不要使用"相等"(==)运算符,只使用"严格相等"(===)

前端JS编码规范

对初学者来说应该学习的JavaScript编码规范: 传送门: http://blog.chinaunix.net/xmlrpc.php?r=blog/article&uid=29292475&id=5019448

javascript编码规范[原创]

一些命名规范书或js书命名规范章节,喜欢将命名规范跟语法混在一块例如: 1.使用“var”定义.初始化变量防止产生全局变量,多变量一块定义使用“,”(本身这种方式就很有争议). 2.结尾必加“;”防止js执行效果跟想象中不一样. 3.判断两数相等使用“===”不要使用“==”.(实际上==会出问题情况很少发生,而js的语法章节也会提及建议使用“===”) 等等导致规范过于冗长,在我看来,命名规范不应太多,而是将实地编码中最常用到的列出即可. 研究过一些框架低层代码.看完<编写可维护的代码>整理

前端(HTML/CSS/JS)-HTML编码规范

一.HTML编码规范 1. img标签要写alt属性 根据W3C标准,img标签要写alt属性,如果没有就写一个空的.但是一般要写一个有内容的,根据图片想要表达的意思,因为alt是在图片无法加载时显示的文字 如下不太好的写法: <img src="company-logo.svg" alt="ABC Company Logo"> 更好的写法: <img src="chime-logo.svg" alt="ABC Com

html编码规范

不久前接到老大下达的任务,要拟定一份公司前端编码规范的草稿,参考了各大公司的编码规范,结合现在公司的特点,整理出以下编码规范: html规范 1 文件相关 (1) 文件名以英文为主,可以使用下划线(如active.html),压缩包以项目名+日期的形式. (2) 统一使用utf-8编码. (3) css.js发布到线上都需要压缩. (4) 在追求高度优化的站点,需要对图片也进行无损压缩. 2 代码风格 2.1 命名 (1) 元素 id 必须保证页面唯一.(解释:同一个页面中,不同的元素包含相同的

【转】Airbnb React编码规范

Airbnb的编码规范是在业界非常流行的一套规范,而且它一直都在进化,推出最新技术的规范 原文:https://zhuanlan.zhihu.com/p/20616464 用更合理的方式书写React和JSX 基本规则 每个文件只包含一个React组件: 但是无状态, 或者 Pure 组件 允许一个文件包含多个组件.eslint: react/no-multi-comp. 始终使用 JSX 语法; 不要使用 React.createElement方法,除非初始化 app 的文件不是 JSX 格式

Bootstrap编码规范

黄金定律 永远遵循同一套编码规范 -- 可以是这里列出的,也可以是你自己总结的.如果你发现本规范中有任何错误,敬请指正.通过 open an issue on GitHub为本规范添加或贡献内容. 不管有多少人共同参与同一项目,一定要确保每一行代码都像是同一个人编写的. HTML 语法 用两个空格来代替制表符(tab) -- 这是唯一能保证在所有环境下获得一致展现的方法. 嵌套元素应当缩进一次(即两个空格). 对于属性的定义,确保全部使用双引号,绝不要使用单引号. 不要在自闭合(self-clo

web项目开发 之 前端规范 --- JavaScript编码规范

JavaScript编码规范 此文严格按照W3C规范和部分实际项目可读性,浏览器加载,性能等众多属性权衡,做出平时前端编码规范文档.供广大web工作者参考并实施,对维护和项目扩展升级都能省时省力. 场景:web前端开发中 一些Javascript的注意事项 和 规格建议: [参考百度资料 和个人一些总结] 1 前言 JavaScript 在百度一直有着广泛的应用,特别是在浏览器端的行为管理.本文档的目标是使 JavaScript 代码风格保持一致,容易被理解和被维护. 虽然本文档是针对 Java