前端规范

代码缩进

  • 4个空格

分号

  • 除代码块外的语句末尾都加分号

不推荐

let baz = { a: 1 }
function foo() { return true };
if (foo) { bar = 0 };

推荐

let baz = { a: 1 };
function foo() { return true; }
if (foo) { bar = 0; }

命名

变量名/属性名

  • 驼峰式 name / firstName / lastName
  • 标志型的体现标志 isLoading / hasLoaded
  • 全局变量命名语义化,尽量详细 globalCityName

函数名/方法名

  • 驼峰式 goIndex
  • 体现功能 getValue / setValue / sortResult

样式名

  • 下划线 mod_info
  • 体现层级关系 city / city_name

组件名/类名

  • 首字母大写 Order
  • 驼峰式 OrderList / OrderDetail

文件名

  • 中划线 order.js / order-list.js / order-detail.js
  • 体现功能 order-reducer.js / order-action.js

空行

代码块之间空行

  • 方法与方法之间空行
  • import与class之间空行

拖尾换行

  • 文件末尾留一空行

在非空文件中,存在拖尾换行是一个常见的 UNIX 风格,它的好处是可以方便在串联和追加文件时不会打断 Shell 的提示。在日常的项目中,保留拖尾换行的好处是,可以减少版本控制时的代码冲突。

空格

操作符空格

  • 操作符前后都需要添加空格

不推荐

let sum=1+2

推荐

let sum = 1 + 2

关键字空格

  • 关键字后面加空格

不推荐

if(condition) { ... }

推荐

if (condition) { ... }

行末空格

  • 行末不留空格

不推荐

let a = 1;   

推荐

let a = 1;

函数命名/调用空格

  • 函数声明与调用相同:参数左小括号前不加空格,右小括号后加空格

不推荐

function func () {
  // do something
}
func ()

推荐

function func() {
  // do something
}
func()

逗号,冒号,分号空格

  • 后面使用空格,前面不加空格
    注意行末不留空格

不推荐

[1,2,3]
let baz = { a:1 }
for (let a = 1;a <= 10;a++) { }

推荐

[1, 2, 3]
let baz = { a: 1 }
for (let a = 1; a <= 10; a++) { }

单行代码块空格

  • 在单行代码块中使用空格,左花括号后与右花括号前空格

不推荐

function foo() {return true;}
if (foo) {bar = 0}

推荐

function foo() { return true; }
if (foo) { bar = 0 }

圆括号空格

  • 圆括号间不留空格

不推荐

getName( name );

推荐

getName(name);

注释首尾空格

  • 注释首尾留空格

不推荐

//comment
/*comment*/

推荐

// comment
/* comment */

空格个数

  • 除了缩进,不要使用多个空格。

不推荐

const id =    1234;

推荐

const id = 1234;

无子元素组件闭合

  • 使用单标签

不推荐

<View></View>

推荐

<View />

字符串

  • 单引号
  • 拼接变量统一ES6模板字符串

顺序

函数内代码区域排序

  • const/let/var
  • 代码块内变量需提前声明

模块js文件代码区域排序

  • import
  • const/let/global
  • Class
  • export

React生命周期方法与其他方法顺序问题

constructor() { }
componentWillMount() { }
render() { }
componentDidMount() { }
componentWillReceiveProps() { }
shouldComponentUpdate() { }
componentWillUpdate() { }
componentDidUpdate() { }
componentWillUnmount() { }
// 其他方法...

目录结构

非公共模块

不同模块的组件文件、样式文件、图片使用相同的目录存储

公共模块

每个模块使用自己独立的组件目录、样式目录、图片目录(便于移植)

换行问题

  • 一行代码字符过多时酌情换行处理(不要出现横向滚动条?)

温馨提示

  • 短路操作符 && || 在特定情境下需要转换为布尔值,否则可能会报错
{!!length && <View />}
  • 条件语句内合理使用隐式转换
    禁止 a == false / a == null / a == 0 / a == '' / a == undefined
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,948评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,371评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,490评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,521评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,627评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,842评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,997评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,741评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,203评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,534评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,673评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,339评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,955评论 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,770评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,000评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,394评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,562评论 2 349

推荐阅读更多精彩内容

  • 最佳原则 坚持制定好的代码规范。无论团队人数多少,代码应该同出一门。如果你想要为这个规范做贡献或觉得有不合理的地方...
    Tiny_ae3d阅读 1,623评论 0 1
  • 1:通用规范 tab键用两个空格代替 因为在不同系统的编辑工具对tab解析不一样,windows下的tab键是占四...
    糖心m阅读 454评论 0 1
  • 通用规范 tab键用两个空格代替 因为在不同系统的编辑工具对tab解析不一样,windows下的tab键是占四个空...
    戈薇薇阅读 468评论 0 1
  • 通用规范 tab键用两个空格代替 因为在不同系统的编辑工具对tab解析不一样,windows下的tab键是占四个空...
    米塔塔阅读 413评论 0 7
  • 通用规范 tab键用两个空格代替因为在不同系统的编辑工具对tab解析不一样,windows下的tab键是占四个空格...
    熊猫猫超人阅读 29,913评论 17 113