js代码规范 - CSDN
精华内容
参与话题
  • js代码规范

    2018-10-19 21:10:56
    JavaScript 代码规范 代码规范通常包括以下几个方面: 变量和函数的命名规则 空格,缩进,注释的使用规则。 其他常用规范…… 规范的代码可以更易于阅读与维护。 代码规范一般在开发前规定,可以跟你的团队成员...

    JavaScript 代码规范

    代码规范通常包括以下几个方面:

    • 变量和函数的命名规则
    • 空格,缩进,注释的使用规则。
    • 其他常用规范……

    规范的代码可以更易于阅读与维护。

    代码规范一般在开发前规定,可以跟你的团队成员来协商设置。


    变量名

    变量名推荐使用驼峰法来命名(camelCase):

    firstName = "John";
    lastName = "Doe";

    price = 19.90;
    tax = 0.20;

    fullPrice = price + (price * tax);


    空格与运算符

    通常运算符 ( = + - * / ) 前后需要添加空格:

    实例:

    var x = y + z;
    var values = ["Volvo", "Saab", "Fiat"];


    代码缩进

    通常使用 4 个空格符号来缩进代码块:

    函数:

    function toCelsius(fahrenheit) {
        return (5 / 9) * (fahrenheit - 32);
    }

    Note 不推荐使用 TAB 键来缩进,因为不同编辑器 TAB 键的解析不一样。

    语句规则

    简单语句的通用规则:

    • 一条语句通常以分号作为结束符。

    实例:

    var values = ["Volvo", "Saab", "Fiat"];

    var person = {
        firstName: "John",
        lastName: "Doe",
        age: 50,
        eyeColor: "blue"
    };

    复杂语句的通用规则:

    • 将左花括号放在第一行的结尾。
    • 左花括号前添加一空格。
    • 将右花括号独立放在一行。
    • 不要以分号结束一个复杂的声明。

    函数:

    function toCelsius(fahrenheit) {
        return (5 / 9) * (fahrenheit - 32);
    }

     

    循环:

    for (i = 0; i < 5; i++) {
        x += i;
    }

     

    条件语句:

    if (time < 20) {
        greeting = "Good day";
    } else {
        greeting = "Good evening";
    }


    对象规则

    对象定义的规则:

    • 将左花括号与类名放在同一行。
    • 冒号与属性值间有个空格。
    • 字符串使用双引号,数字不需要。
    • 最后一个属性-值对后面不要添加逗号。
    • 将右花括号独立放在一行,并以分号作为结束符号。

    实例:

    var person = {
        firstName: "John",
        lastName: "Doe",
        age: 50,
        eyeColor: "blue"
    };

    短的对象代码可以直接写成一行:

    实例:

    var person = {firstName:"John", lastName:"Doe", age:50, eyeColor:"blue"};


    每行代码字符小于 80

    为了便于阅读每行字符建议小于数 80 个。

    如果一个 JavaScript 语句超过了 80 个字符,建议在 运算符或者逗号后换行。

    实例:

    document.getElementById("demo").innerHTML =
        "Hello Runoob.";


    尝试一下 »


    命名规则

    一般很多代码语言的命名规则都是类似的,例如:

    • 变量和函数为小驼峰法标识, 即除第一个单词之外,其他单词首字母大写( lowerCamelCase
    • 全局变量为大写 (UPPERCASE )
    • 常量 (如 PI) 为大写 (UPPERCASE )

    变量命名你是否使用这几种规则: hyp-henscamelCase, 或 under_scores ?

    HTML 和 CSS 的横杠(-)字符:

    HTML5 属性可以以 data- (如:data-quantity, data-price) 作为前缀。

    CSS 使用 - 来连接属性名 (font-size)。

    Note - 通常在 JavaScript 中被认为是减法,所以不允许使用。

    下划线:

    很多程序员比较喜欢使用下划线(如:date_of_birth), 特别是在 SQL 数据库中。

    PHP 语言通常都使用下划线。

    帕斯卡拼写法(PascalCase):

    帕斯卡拼写法(PascalCase) 在 C 语言中语言较多。

    驼峰法:

    JavaScript 中通常推荐使用驼峰法,jQuery 及其他 JavaScript 库都使用驼峰法。

    Note 变量名不要以 $ 作为开始标记,会与很多 JavaScript 库冲突。

    HTML 载入外部 JavaScript 文件

    使用简洁的格式载入 JavaScript 文件 ( type 属性不是必须的):

    <script src="myscript.js">


    使用 JavaScript 访问 HTML 元素

    一个糟糕的 HTML 格式可能会导致 JavaScript 执行错误。

    以下两个 JavaScript 语句会输出不同结果:

    实例

    var obj = getElementById("Demo")

    var obj = getElementById("demo")


    尝试一下 »

    HTML 与 JavaScript 尽量使用相同的命名规则。

    访问 HTML(5) 代码规范


    文件扩展名

    HTML 文件后缀可以是 .html (或 .htm)。

    CSS 文件后缀是 .css 。

    JavaScript 文件后缀是 .js 。


    使用小写文件名

    大多 Web 服务器 (Apache, Unix) 对大小写敏感: london.jpg 不能通过 London.jpg 访问。

    其他 Web 服务器 (Microsoft, IIS) 对大小写不敏感: london.jpg 可以通过 London.jpg 或 london.jpg 访问。

    你必须保持统一的风格,我们建议统一使用小写的文件名。

    展开全文
  • js代码规范

    2019-07-02 09:34:15
    https://www.zcfy.cc/article/clean-code-javascript-readme-md-at-master-ryanmcdermott-clean-code-javascript-github-2273.html
    展开全文
  • React.js 代码编写规范

    2019-02-14 13:21:30
    组件的私有方法都用 _ 开头,所有事件监听的方法都用 handle 开头。把事件监听方法传给组件的时候,属性名...这样统一规范处理事件命名会给我们带来语义化组件的好处,监听(on)CommentInput 的 Submit 事件...

    组件的私有方法都用 _ 开头,所有事件监听的方法都用 handle 开头。把事件监听方法传给组件的时候,属性名用 on 开头。例如:

    <CommentInput
      onSubmit={this.handleSubmitComment.bind(this)} />
    

    这样统一规范处理事件命名会给我们带来语义化组件的好处,监听(onCommentInput 的 Submit 事件,并且交给 this 去处理(handle)。这种规范在多人协作的时候也会非常方便。

    另外,组件的内容编写顺序如下:

    1. static 开头的类属性,如 defaultPropspropTypes
    2. 构造函数,constructor
    3. getter/setter(还不了解的同学可以暂时忽略)。
    4. 组件生命周期。
    5. _ 开头的私有方法。
    6. 事件监听方法,handle*
    7. render*开头的方法,有时候 render() 方法里面的内容会分开到不同函数里面进行,这些函数都以 render* 开头。
    8. render() 方法。

    如果所有的组件都按这种顺序来编写,那么维护起来就会方便很多,多人协作的时候别人理解代码也会一目了然。

    展开全文
  • 前端js代码规范

    2020-07-29 14:20:26
    前端代码规范
  • 前端中常见的几种js代码规范工具 在参加前端培训学习中大家一定都会用到js代码规范的工具,这样不及可以提高开发效率还可以避免一些常见的隐患,做前端开发的人都知道,由于项目开发一般都是团队合作完成,前端...

    前端中常见的几种js代码规范工具

     

    在参加前端培训学习中大家一定都会用到js代码规范的工具,这样不及可以提高开发效率还可以避免一些常见的隐患,做前端开发的人都知道,由于项目开发一般都是团队合作完成,前端开发程序员水平参差不齐、开发习惯也不相不同,项目的不断迭代会导致代码质量问题、代码维护问题、可读性问题的出现,所以在前端培训学习的时候就应该养成良好的习惯,方便以后工作。


    JSLint
    JSLint是其中最老的工具。在2002年 Douglas Crockford开发了该工具,根据其经验,强制使用js语言中精粹的部分。如果你同意这些精粹,JSLint能成为一个好的工具。
    JSLint的缺点是不能配置和拓展。你根本不能禁掉需要特性,并且很多缺少文档。官方文档非常不友好,例如缺少如何将其集成到编辑的信息。
    优点
    参数配置完成,可以直接使用
    JSHint
    作为一个可配置的JSLint版本,JSHint被开发出来。你可以配置每个规则,将其放到一个配置文件中,这样在大项目中可以容易使用。JSHint对每个规则有好的文档,所以可以准确知道每个规则的作用。将其集成到编辑器也是简单的。
    JSHint的一个小缺点是里面的松散默认配置。也即是你在使其可用之前必须将其启动。和ESLint相比,确定哪个规则用户开启或关闭错误信息,JSHint是更加困难。
    优点
    大多是参数可以配置
    支持配置文件,在大项目中容易使用
    已经支持需要类库,像jQuery、QUnit、NodeJS、Mocha等
    支持基本的ES6
    JSCS
    JSCS不同于其他,因为如果不给它一个配置文件或告诉它一个配置项,JSCS不会做任何事情。可以存他们的网站现在配置项,所以这不是个大问题,并且有许多配置项,例如jQuery代码风格配置项、Google配置项。
    它有超过90个不同的规则,通过插件可以创建自定义规则。当和其他工具集成需要特定格式时,JSCS也支持自定义报告使得变得非常容易。
    JSCS是一个代码风格检查器。这意味着它仅仅匹配代码格式的问题,不匹配潜在的bugs、errors。因此,跟其他工具相比缺少灵活性,但是如果你仅仅强制检查代码风格,JSCS也是一个好的工具。
    优点
    支持自定义报告,更容易与其他工具集成
    如果你遵循一种可用的代码风格,配置项和准备好的配置文件使其容易启动
    在报告中存在标记包含规则名字,所以很容易指出哪个规则造成了错误
    通过自定义插件进行拓展
    ESLint
    ESLint是最新出来的工具。它被设计的容易拓展、拥有大量的自定义规则、容易的通过插件来安装。它给出准确的输出,而且包括规则名,这样可以知道哪个规则造成了错误。
    ESLint文档多少有些混乱。规则容易查找,以及被分为逻辑组,但是配置指南在有些地方容易弄混。然而它可以在一个地方提供链接去编辑集成、插件和样例。
    优点
    灵活,任何规则都可以开启闭合,以及有些规则有些额外配置
    很容易拓展和有需要可用插件
    容易理解产出
    包含了在其他检查器中不可用的规则,使得ESLint在错误检查上更有用
    支持ES6,唯一支持JSX的工具
    支持自定义报告
    使用建议
    综上所述,我的建议是ESLint。JSHint是严格和不可配置的,而JSHint缺少拓展机制。JSCS如果仅仅用于代码风格检验是一个好的选择,但是ESLint不仅可以进行代码风格的检验,而且可以检查代码中的bug和其他问题。
    所以在前端培训学习中要掌握好js工具的使用,如果使用ES6,ESLint是明显的选择。在上面提到的工具中,ESLint对ES6支持的最广泛。
    文章来源:前端培训

    展开全文
  • JS代码编写规范

    千次阅读 2019-04-16 17:33:47
    全部采用小写方式,以下划线分隔,例:my_project_name、account_model.js。 2. 统一规范 1、使用Tab缩进,每嵌套一级缩进一个Tab,“()”需保持缩进对齐; 2、一行代码只做一件事; 3、长行拆分。 A..字符串...
  • JS编写规范

    千次阅读 2016-08-01 16:46:22
    编写JS时需要遵守的规范
  • JS代码规范

    2018-04-10 14:09:20
    2空格缩进使用 2 个空格而不是 tab 来进行代码缩进,同时绝对不要混用空格和 tab 。Sublime Text 2 设置(perfernces &gt; Settings - User): "tab_size": 2, "translate_tabs_to_spaces"...
  • 编写优雅的JavaScript——前言

    万次阅读 2016-06-25 19:06:56
    这篇文章是javascript开发规范一系列文章的前言,介绍了规范的重要性以及这个系列文章的适合人群。这个些列的文章会以持续更新的形式与大家分享JS开发时应该注意的事项,想要学习和提升的朋友可以关注我的博客
  • vscode 一键规范代码格式

    万次阅读 2020-04-13 15:35:59
    作为一个成熟的开发 , 当然应该遵守一些代码规范, 首先代码整洁度应该排在第一位 使用vscode 格式化代码 在少量的情况下 可能可以手动去修改格式, 但在大量格式排版不对齐的情况下, 应该怎么做? 文件 -> 首选项...
  • js/javascript代码注释规范与示例

    万次阅读 2016-10-15 10:47:27
    js/javascript代码注释规范与示例  注释在代码编写过程中的重要性,写代码超过半年的就能深深的体会到。没有注释的代码都不是好代码。为了别人学习,同时为了自己以后对代码进行‘升级’,看看js/...
  • 原贴:http://www.1j3k.cn/js-format.html对杂乱的JS代码进行规范的整理格式化格式化, 压缩. 经典, 微软.www.1j3k.cn/js-format.html - 网页快照 - 类似结果 
  • js函数注释规范

    万次阅读 2017-08-07 09:25:59
    之前,写代码的时候都是很简单的一种注释,或者有些压根没有注释。注释是代码的一部分,一个完整的程序必须有注释。这样不仅方便自己更新和维护项目,更有利于日后他人 接手你的项目时可以快速知道你写的是什么。 ...
  • 简要理解CommonJS规范

    万次阅读 2019-10-12 09:29:16
     另外本文中的示例代码需要在node.js环境中方可正常运行,否则将出现错误。事实上ES6已经出现了模块规范,如果使用ES6的模块规范是无需node.js环境的。因此,需要将commonJS规范和ES6的模块规范区分开来。 一、为...
  • JavaScript语法规范

    万次阅读 2019-03-25 16:00:31
    目录 1.标识符的命名规范 2.程序注释 3.常用标识符命名方法 4.ECMAScript5严格模式 ...JavaScript编写语法遵循ECMAScript标准,以下是ECMAScript语言的一些基本规范。 1.标识符的命名规范 ECMAScript标识...
  • Java直接运行JavaScript代码js文件

    万次阅读 2017-11-13 20:07:10
    执行JavaScript用到的类有: javax.script.ScriptEngine; javax.script.ScriptEngineFactory; javax.script.ScriptEngineManager; javax.script.ScriptException;刚哥做事,必须雷厉风行!话不多说,先上代码,一...
  • HTML中javascript的标签使用方法详解

    万次阅读 2016-01-07 01:10:21
    只要一提到把JavaScript放到网页中,就不得不涉及Web的核心语言——HTML。在当初开发JavaScript的时候,Netscape要解决的一个重要问题就是如何做到让JavaScript既能与HTML页面共存,又不影响那些页面在其他浏览器中...
  • Javascript注释规范

    万次阅读 2017-11-14 16:15:12
    Javascript注释规范
  • Javascript入门笔记1-script标签

    万次阅读 2016-10-31 22:10:58
    javascript 入门笔记
  • 养成良好的代码习惯,规范代码规范的注释便于后续维护。 文档说明注释 Webstorm js中,自定义js说明注释(文档描述、作者、创建日期等): 快捷键 Ctrl + Shift + S 打开Webstorm设置,搜索‘Live Template’,...
1 2 3 4 5 ... 20
收藏数 207,156
精华内容 82,862
热门标签
关键字:

js代码规范