腾讯Alloy团队代码规范
概述
我个人很看重代码规范,因为代码是写给别人看的,按规范写别人才更容易理解。之前苦于没有代码规范的资料,现在在github上面看到了腾讯Alloy团队的代码规范,于是学习了一下,并记录下我自己还没怎么注意的地方,供以后开发时参考,相信对其他人也有用。
顺便说下,这里是腾讯Alloy团队推荐的sublime3配置。
命名规则
- 文件命名全部采用小写方式, 以下划线分隔,有复数结构时,要采用负数命名法。
HTML
- 属性名,使用双引号,不要使用单引号;全小写,用中划线做分隔符。
- 不要在自动闭合标签结尾处使用斜线。
- doctype大写。
- 在html标签上加上lang属性。
- 声明一个明确的字符编码,通常指定为'UTF-8'。
- 用meta标签指定页面应该用什么版本的IE来渲染(比如content="IE=Edge");
- 在引入CSS和JS时不需要指明type。
- 属性应该按照特定的顺序出现以保证易读性,class>id>name>data-*>src等
- boolean属性不需要声明取值。
- 避免用js生成标签。
- 在编写HTML代码时,需要尽量避免多余的父节点。
css,scss
- 属性声明顺序。
- 以下几种情况需要换行:(1)'{'后和'}'前(2)每个属性独占一行(3)多个规则的分隔符','后。
- 注释统一用'/* */'(scss中也不要用'//')。
- 最外层统一使用双引号。
- 类名使用小写字母,以中划线分隔;id采用驼峰式命名;scss中的变量、函数、混合、placeholder采用驼峰式命名。
- 颜色16进制用小写字母;颜色16进制尽量用简写。
- 除了margin和padding,都不需要使用属性简写,尽量分开声明。
- 尽量将媒体查询的规则靠近与他们相关的规则,不要放进独立样式文件,也不要扔在底部。
- @import 引入的文件不需要开头的'_'和结尾的'.scss'。
- 声明顺序:@extend;不包含 @content 的 @include;包含 @content 的 @include;自身属性;嵌套规则。
- 去掉小数点前面的0。
- 属性值'0'后面不要加单位。
- 同个属性不同前缀的写法需要在垂直方向保持对齐,无前缀的标准属性应该写在有前缀的属性后面。
- 用 border: 0; 代替 border: none;
- 发布的代码中不要有 @import。
- 尽量少用'*'选择器。
JavaScript
- return后面需要加分号。
- 这些关键字后要留一个空格:if, else, for, while, do, switch, case, try, catch, finally, with, return, typeof。
- '}'前需要换行。
- 单行注释缩进与下一行代码保持一致。
- 多行注释最少三行, '*'后跟一个空格。
- 最外层统一使用单引号。
- 这些字符串一律按这里的写法,不小写或大写:'ID','URL','Android', 'iOS'。
- 构造函数,大写第一个字母
- 常量全大写,用下划线连接。
- 对象属性名不需要加引号;数组、对象最后不要有逗号。
- 永远不要直接使用undefined进行变量判断;使用typeof和字符串'undefined'对变量进行判断。
- for-in里一定要有hasOwnProperty的判断。
- 不要在同个作用域下声明同名变量。
- 不要在一些不需要的地方加括号,例:delete(a.b)。
- 数组中不要存在空元素。(有疑问???)
- 换行符统一用'LF',即'/n'。
- 对上下文this的引用只能使用'_this', 'that', 'self'其中一个来命名。
- 一个函数作用域中所有的变量声明尽量提到函数首部,用一个var声明,不允许出现两个连续的var声明。比如:
function doSomethingWithItems(items) {
// use one var
var value = 10,
result = value + 10,
i,
len;
for (i = 0, len = items.length; i < len; i++) {
result += 10;
}
}
腾讯Alloy团队代码规范的更多相关文章
- 中小型前端团队代码规范工程化最佳实践 - ESLint
前言 There are a thousand Hamlets in a thousand people's eyes. 一千个程序员,就有一千种代码风格.在前端开发中,有几个至今还在争论的代码风格差 ...
- iOS团队代码规范
iOS团队代码规范 工程之始可能需要的工具: 1.使用CocoaPods类库管理工具.CocoaPods安装和使用教程. 2.下载安装注释插件VVDocumenter-Xcode. 一.项目结构管理 ...
- 项目Alpha冲刺(团队)-代码规范、冲刺任务与计划
课程名称:软件工程1916|W(福州大学) 作业要求:项目Alpha冲刺(团队)-代码规范.冲刺任务与计划 团队名称:SkyReach 作业目标:确定团队项目的代码规范.冲刺任务与计划 代码规范:隐流 ...
- 团队开发前端VUE项目代码规范
团队开发前端VUE项目代码规范 2018年09月22日 20:18:11 我的小英短 阅读数 1658 一.规范目的: 统一编码风格,命名规范,注释要求,在团队协作中输出可读性强,易维护,风格一致 ...
- PHP团队 编码规范 & 代码样式风格规范
一.基本约定 1.源文件 (1).纯PHP代码源文件只使用 <?php 标签,省略关闭标签 ?> : (2).源文件中PHP代码的编码格式必须是无BOM的UTF-8格式: (3).使用 U ...
- sixsix团队“餐站”应用代码规范及开发文档
网络爬虫文档 以下是我们软工小组关于网络爬虫部分代码的的说明文档.至于一些分功能的小函数或方法就不在此赘述,一看就能明白.下面就主要的函数进行说明. 从总体上来说主要有三部分:店家信息爬取部分,菜品信 ...
- 猪懂傻改之《powershell 代码规范》
猪懂傻改之<powershell 代码规范> 脚本程序员或许都经历过这样的场景:接手别人的代码时,因为没有注释,变量名五花八门,模块之间逻辑关系如麻,弄得满头雾水,一脸茫然,痛定思痛之后不 ...
- 腾讯QQ团队开源分布式后台毫秒服务引擎全解析:引擎架构、RPC、灰度……
腾讯QQ团队将于12月4日开源一个服务开发运营框架,叫做毫秒服务引擎(Mass Service Engine in Cluster,MSEC),它集RPC.名字发现服务.负载均衡.业务监控.灰度发布. ...
- iOS代码规范(OC和Swift)
下面说下iOS的代码规范问题,如果大家觉得还不错,可以直接用到项目中,有不同意见 可以在下面讨论下. 相信很多人工作中最烦的就是代码不规范,命名不规范,曾经见过一个VC里有3个按钮被命名为button ...
随机推荐
- SQLite在Android程序中的使用方法,SQLite的增删查改方法
Sqlite: 1.一款用来实现本地数据存储的轻量级数据管理工具,是众多用来实现数据库管理的工具之一. 2.Android已经将SQLite的代码功能吸收在它的系统中,我们可以直接在Android程序 ...
- json 异常
com.google.gson.JsonSyntaxException: 1530842820000 1530842820000 是服务器直接返回的Date值由 Gson 解析后出来的值. 后台发出: ...
- java DES加解密及Wrong key size错误
如下的DES加密方法会报错:Wrong key size public static String encryptDES(String source) throws Exception{ Secret ...
- springboot 整合 mybatis
spirngboot 整合mybatis有两种方式 第一种 无配置文件注解版,这一种符合springboot的风格 第二种 有配置文件xml版本,这一种就是传统的模式 无论哪一种,首先都需要加入MyS ...
- java学习笔记(三):类和对象
创建对象 构造器 每一个类都有一个构造器. 如果我们不单独为一个类编写构造器那么 Java 的编译器将会给这个类建立一个默认的构造器. 每当一个新的对象被创建,至少一个构造器将会被调用. 构造器的一 ...
- Unity 2018 By Example 2nd Edition
Unity is the most exciting and popular engine used for developing games. With its 2018 release, Unit ...
- [leetcode]380. Insert Delete GetRandom O(1)常数时间插入删除取随机值
Design a data structure that supports all following operations in average O(1) time. insert(val): In ...
- IP、TCP、DNS协议
·······················································IP协议························· 位于网络层,作用是把数据包传送 ...
- predict predict_proba区别的小例子
predict_proba返回的是一个n行k列的数组,第i行第j列上的数值是模型预测第i个预测样本的标签为j的概率.所以每一行的和应该等于1. 举个例子 >>> from sklea ...
- jquery 判断 元素是否具有某个class
两种方法如下: 1.hasClass(‘classname’) 2.is(‘.classname’) 例子: 1.使用is(‘.classname’)的方法 $('div').is('.redColo ...