编码规范与编码风格

有多个指标可以衡量我们编写的代码的质量:

  • 正确性
  • 可读性
  • 性能

按照 Douglas Crockford 的理念,可读性一定比代码的速度更重要,可读性处在与正确性不相上下的地位。为了提高前端代码的可读性从而提高其可维护性,不少团队都会约定内部的编码规范,例如 Airbnb 在 Github 上推出的 JavaScript Style Guide。

要想在团队内统一编码规范也许并非易事,这很有可能会掀起关于个人编码风格的争论,但这些争论通常毫无意义。

我也看到过有人就风格的正确与否争论了半天,但这些解释都毫无意义,因为他们真正争论的是自己在学校里用的是什么、在第一份工作中又用到了什么风格,或者是影响过他的某人使用了哪种风格,那这种风格就是正确的,而其他则是错误的。

……更重要的是每个人都能达成共识。

Douglas Crockford,《编程人生》(上卷)

K&R 风格。

注释

编写可维护代码的关键点之一是注释。许多人都认同“自说明式代码”,意思是通过良好的变量命名、清晰的分支路线等让代码清晰。但这其实往往只适用于小范围的代码。就大型的函数或者模块的话,通过文档或文档式的注释来说明会更好(Brendan Eich 也持有类似的观点[1])。

ESLint

React/JSX 编码规范

Airbnb React/JSX Style Guide

A mostly reasonable approach to React and JSX.