JavaScript 规范 全局命名空间污染与 IIFE 总是将代码包裹成一个 IIFE(Immediately-Invoked Function Expression),用以创建独立隔绝的定义域.这一举措可防止全局命名空间被污染. IIFE 还可确保你的代码不会轻易被其它全局命名空间里的代码所修改(i.e. 第三方库,window 引用,被覆盖的未定义的关键字等等). 不推荐 var x = 10, y = 100; // Declaring variables in the global s…
JavaScript 规范 全局命名空间污染与 IIFE 总是将代码包裹成一个 IIFE(Immediately-Invoked Function Expression),用以创建独立隔绝的定义域.这一举措可防止全局命名空间被污染. IIFE 还可确保你的代码不会轻易被其它全局命名空间里的代码所修改(i.e. 第三方库,window 引用,被覆盖的未定义的关键字等等). 不推荐 var x = 10, y = 100; // Declaring variables in the global s…
一个好的程序员肯定是要能书写可维护的代码,而不是一次性的代码,怎么能让团队当中其他人甚至一段时间时候你再看你某个时候写的代码也能看懂呢,这就需要规范你的代码了.我是有一点强迫症的人,上周我们后端给我了一个CanUsename的接口(该接口的目的是判断输入的目的地是否是4级目的地),我真的是崩溃的.我只是觉得这个名字不够语义化,但是让我自己想一个名字我又想不出来,于是我就在想,如果有一套命名规范的话,那么以后起名字就不用发愁了,直接按照规范来就好了~于是端午在家就百度了一下~ 命名 驼峰式命名法介…
HTML 规范 文档类型 推荐使用 HTML5 的文档类型申明: <!DOCTYPE html>. (建议使用 text/html 格式的 HTML.避免使用 XHTML.XHTML 以及它的属性,比如 application/xhtml+xml 在浏览器中的应用支持与优化空间都十分有限). HTML 中最好不要将无内容元素[1] 的标签闭合,例如:使用 <br> 而非<br />. HTML 验证 一般情况下,建议使用能通过标准规范验证的 HTML 代码,除非在性能优…
所有 PSR 规范请见:https://learnku.com/docs/psr  https://learnku.com/laravel/t/2079/psr-specification-psr-2-coding-style-specification https://psr.phphub.org/ 编码风格指南 本篇规范是 PSR-1 基本代码规范的继承与扩展. 本规范希望通过制定一系列规范化PHP代码的规则,以减少在浏览不同作者的代码时,因代码风格的不同而造成不便. 当多名程序员在多个项目…
一.Google JavaScript编码风格 简体中文版 Google JavaScript Style Guide 二.Google HTML/CSS代码风格指南 简体中文版 三.Google C++编程风格指南 简体中文版 四.Google Python编程风格指南 简体中文版 五.Google Shell编程风格指南 简体中文版…
上次浅谈了下关于CSS的编码规范,大部分童鞋持赞同意见,仍存在一些童鞋不太理解这些规范的意义. 如果是个人或者小作坊开发,其实这些所谓的编码规范也没啥意思,因为大家写好的代码直接就给扔到网上去了,很少有打包.压缩.校检等过程,别人来修改你代码的情况也比较少.但是,对于一定规模的团队来说,这些东西还是挺有必要的!一个是保持代码的整洁美观,同时良好的代码编写格式和注释方式可以让后来者很快地了解你代码的大概思路,提高开发效率. 那么这次,继续抛砖引玉,说说Javascript一些需要引起注意的地方(这…
"字是门面书是屋",我们不会去手写代码,但是敲出来的代码要好看.有条理,这还必须得有一点约束~ 团队开发中,每个人的编码风格都不尽相同,有时候可能存在很大的差异,为了便于压缩组件对代码进行压缩以及书写样式的规范统一和美观,很有必要大家一起来研究一套基本规范(模板)! 我先抛砖引玉.(禁止).(必须)等字眼,在这里只是表示强调,未严格要求. 前端规范之CSS 1. tab键用(必须)四个空格代替 因为在不同系统的编辑工具对tab解析不一样,windows下的tab键是占四个空格的位置,而…
CSS and Sass (SCSS) style rules ID and class naming ID和class(类)名总是使用可以反应元素目的和用途的名称,或其他通用名称.代替表象和晦涩难懂的名称. 应该首选具体和反映元素目的的名称,因为这些是最可以理解的,而且发生变化的可能性最小. 通用名称只是多个元素的备用名,他们兄弟元素之间是一样的,没有特别意义. 区分他们,使他们具有特殊意义,通常需要为“帮手”. 尽管class(类)名和ID 的语义化对于计算机解析来说没有什么实际的意义, 语…
HTML 规范 文档类型 推荐使用 HTML5 的文档类型申明: <!DOCTYPE html>. (建议使用 text/html 格式的 HTML.避免使用 XHTML.XHTML 以及它的属性,比如 application/xhtml+xml 在浏览器中的应用支持与优化空间都十分有限). HTML 中最好不要将无内容元素[1] 的标签闭合,例如:使用 <br> 而非 <br />. HTML 验证 一般情况下,建议使用能通过标准规范验证的 HTML 代码,除非在性能…
说明:本文档为前端JS规范 一.规范目的 为提高团队协作效率,便于前端后期优化维护,输出高质量的文档. 二.基本准则 符合web标准,结构表现行为分离,兼容性优良.页面性能方面,代码要求简洁明了有序, 尽可能的减小服务器负载,保证最快的解析速度. 项目的维护和二次开发可能是直接或间接的团队合作,所以创建易维护的代码是一个项目成功与否的关键,易维护的代码意味着具有如下特性: 阅读性好:如良好的注释和命名规范,有文档 具有一致性:看起来如同一个人编写 代码的松耦合,高度模块化:将页面内的元素视为一个…
转自<前端编码规范之JavaScript>,网址:http://www.cnblogs.com/hustskyking/p/javascript-spec.html 一个是保持代码的整洁美观,同时良好的代码编写格式和注释方式可以让后来者很快地了解你代码的大概思路,提高开发效率. 不规范写法举例 1. 句尾没有分号 var isHotel = json.type == "hotel" ? true : false 2. 变量命名各种各样 var is_hotel; var i…
简要介绍 本文通过参考百度腾讯等前端编码规范(链接建文末),得出个人习惯的编码规范.个人编码规范采用在不影响可读性的情况下能省就省,尽量简洁,不需要就直接去掉. 最佳原则不管是个人编码规范还是团队编码规范,一旦规范制定完毕就应该坚持使用,保持前后规范一致. 笔记通过MarkDown写成,对应的GitHub地址为:https://github.com/xys2015/mdnote 命名规则 项目名称,目录名称,一律采用小写方式,以下划线分割.例如:my_project_name 常见命名推荐:im…
1. 前言 这份文档参考了 Google Java 编程风格规范和 Google 官方 Android 编码风格规范.该文档仅供参考,只要形成一个统一的风格,见量知其意就可. 1.1 术语说明 在本文档中,除非另有说明: 术语 class 可表示一个普通类,枚举类,接口或是annotation类型(@interface)术语 comment 只用来指代实现的注释(implementation comments),我们不使用”documentation comments”一词,而是用 Javado…
前端编码规范,个人感觉bootstrap总结的不错,拿出来给大家分享 http://codeguide.bootcss.com/#html-doctype HTML 语法 HTML5 doctype 语言属性(Language attribute) 字符编码 IE 兼容模式 引入 CSS 和 JavaScript 文件 实用为王 属性顺序 布尔(boolean)型属性 减少标签的数量 JavaScript 生成的标签 CSS 语法 声明顺序 媒体查询(Media query)的位置 带前缀的属性…
前端JavaScript规范 http://www.imooc.com/article/1402 http://greengerong.com/blog/2015/05/09/qian-duan-javascriptgui-fan/…
(1) 基本逻辑控制举例和编码风格规范 1.while死循环 2.for循环 3.if,elif,else分支判断 4.编码风格(官方建议) 版本:Python3.4 1.while死循环 #function: endless loop import time i = 0 while 1: i += 1 print(i) time.sleep(3) 执行效果: >>> import time >>> i = 0 >>> while 1: ... i +…
/* * 1.关于编程风格:每一位程序猿可能都有自己独特的编程风格,但是有些规则是大家都必须遵守的,特别 * 是在工作的过程中,良好的代码风格能大大提高代码本身的可阅读性和维护性,也更有利于别人修改你 * 的代码.风格问题涉及到的都是细节相关的问题,读者朋友们或许都听过“细节决定成败”这句话,这句话 * 在这里同样生效,不过是换了种意思,就是“细节体现你的专业程度”,所以作为一名程序猿,我们应该从 * 编写代码的训练中养成良好的编码习惯,如命名规范,排版规范,写好注释等.下面具体说明下: */…
编码风格 错误认知 这很浪费时间 我是个艺术家 所有人都能穿的鞋不会合任何人的脚 我善长制定编码规范 正确认知 促进团队合作 减少bug处理 提高可读性,降低维护成本 有助于代码审查 养成习惯,有助于程序员自身的成长 pep8 编码规范 Python Enhancement Proposals :python改进方案 https://www.python.org/dev/peps/ pep8 官网规范地址 https://www.python.org/dev/peps/pep-0008/ Gui…
之前的一篇文章是对PSR-1的基本介绍 接下来是PSR-2 编码风格规范,它是 PSR-1 基本代码规范的继承与扩展. PSR-1 和PSR-2是PHP开发中基本的编码规范,大家其实都可以参考学习下,虽然说每个开发者都有自己熟悉的一套开发规范,但是我觉得还是根据行业标准来编写我们的代码,毕竟标准都是经过验证的了.希望能对PHP开发者有帮助吧. 1. 概览 代码 必须 遵循 [PSR-1]() 中的编码规范 . 代码 必须 使用4个空格符而不是「Tab 键」进行缩进. 每行的字符数 应该 软性保持…
本篇规范是 PSR-1 基本代码规范的继承与扩展. 本规范希望通过制定一系列规范化PHP代码的规则,以减少在浏览不同作者的代码时,因代码风格的不同而造成不便. 当多名程序员在多个项目中合作时,就需要一个共同的编码规范, 而本文中的风格规范源自于多个不同项目代码风格的共同特性, 因此,本规范的价值在于我们都遵循这个编码风格,而不是在于它本身. 关键词 “必须”("MUST").“一定不可/一定不能”("MUST NOT").“需要”("REQUIRED&qu…
由于PHP的灵活性,很多人写起代码来也不讲求一个好的代码规范,使得本就灵活的PHP代码看起来很乱,其实PSR规范中的PSR-1和PSR-2已经定义了在PHP编码中的一些规范,只要我们好好遵守这些规范,即使是使用灵活的脚本语言,也能写出非常漂亮工整的代码.首先我们来看一下已经通过的PSR规范,然后大致讲解一下PSR-1和PSR-2规范的一些具体要求. 已通过的PSR PSR编号 名称 说明 1 基础编码规范 关于PHP标签和基本命名约定等基础的规范 2 编码风格规范 关于大括号的位置和参数列表等编…
上周小组的培训内容是代码可读性艺术,主要分享如何命名.如何优化代码排版,如何写好的注释.我们都知道写出优雅的代码是成为大牛的必经之路. 下面感谢一位前端开发小伙伴总结的前端开发规范,通过学习相关开发规范,提升自己代码的可读性. 文章来源:http://cherryblog.site/  一个好的程序员肯定是要能书写可维护的代码,而不是一次性的代码,怎么能让团队当中其他人甚至一段时间时候你再看你某个时候写的代码也能看懂呢,这就需要规范你的代码了.我是有一点强迫症的人,上周我们后端给我了一个CanU…
最近在看前端大牛Nicbolas C.Zakas的<编写可维护的JavaScript代码>一书.觉得里面的很多知识点都写的很好,所以,就写篇博文,总结一下吧!编码规范对于程序设计来说是很重要的,因为如果编码风格不一致的话,代码看上去就会很乱,是很难维护的.当然,不同的开发团队有着不同的编码规范,比较著名的有,Google编码规范,jQuery编码规范,dojo编码规范以及Yahoo!编码规范,等等. 第一,Indentation Levels(缩进).目前比较流行的是2空格缩进和4空格缩进,比…
代码规范是软件开发领域经久不衰的话题,几乎所有工程师在开发过程中都会遇到或思考过这一问题.而随着前端应用的大型化和复杂化,越来越多的前端团队也开始重视代码规范.同样,前段时间,笔者所在的团队也开展了一波开源治理,而其中代码规范就占据了很重要的一项.接下来的几篇文章,将会对JS代码规范.CSS规范.Git工作流规范以及文档规范进行详细的介绍~ 系列文章: 前端规范之JS代码规范(ESLint + Prettier) 前端规范之CSS规范(Stylelint) 前端规范之Gti工作流规范(Husky…
前言: 程序语言的编码风格对于一个长期维护的软件非常重要,特别是在团队协作中.如果一个团队使用统一规范的编码分风格,可以提高团队的协作水平和工作效率.编程风格指南的核心是基本的格式化规则,这些规则决定了如何编写高水准的代码.本指南来自于<编写可维护的JavaScript>这本书,基于"Java语言编码规范"和Crockford的JavaScript编程规范,还有Nicbolas的一些个人经验和喜好.写作本文旨在加深自己印象,也为了更多人的了解到JS编码风格,提高自己的编码质…
编码风格 1.概述 "编程风格"(programming style)指的是编写代码的样式规则.不同的程序员,往往有不同的编程风格. 有人说,编译器的规范叫做"语法规则"(grammar),这是程序员必须遵守的:而编译器忽略的部分,就叫"编程风格"(programming style),这是程序员可以自由选择的.这种说法不完全正确,程序员固然可以自由选择编程风格,但是好的编程风格有助于写出质量更高.错误更少.更易于维护的程序. 所以,编程风格的选…
ECMA-262,第 5 版 最新 JavaScript 规范 Rob Larsen, 界面架构师, IBM 简介: 了解 ECMAScript 规范的历史,查看它的众多重要新特性和新概念. 发布日期: 2012 年 5 月 02 日 级别: 中级 原创语言: 英文 访问情况 : 8937 次浏览 评论:  (查看 | 添加评论 - 登录) 平均分 (9个评分) 为本文评分 该标准以标题 ECMA-262,第 5 版(以下简称 ES5)进行发布,是 ECMAScript 规范的最新版本.ECMA…
amazeui学习笔记二(进阶开发4)--JavaScript规范Rules 一.总结 1.注释规范总原则: As short as possible(如无必要,勿增注释):尽量提高代码本身的清晰性.可读性. As long as necessary(如有必要,尽量详尽):合理的注释.空行排版等,可以让代码更易阅读.更具美感. 2.变量命名规则(和之前的C++和Java一样): 常量全大写 UPPERCASE_WORD 变量驼峰 camelName 类名驼峰,并且首字母要大写 CamelName…
HTMLCSS文档规范 HTML和CSS文档必须采用UTF-8编码格式: HTML文档必须使用HTML5的标准文档格式: HTMLCSS编写规范 HTML和CSS的标签.属性.类名.ID都必须使用小写字母: HTML和CSS的属性.类名.ID命名必须具有语义化: HTML代码必须保持文档结构清晰,必须合理的进行代码缩进: CSS文件禁止样式表内引用CSS文件: CSS编写格式,样式代码保持一行,多个选择器同一个规则必须换行,如图1: CSS样式表格分为3个级别:系统级(以lib_开头).模块级(…