编写可维护的JavaScript(二)

JavaScript 编程的本质是编写一个个的函数来完成任务。在函数内部,变量和运算符可以通过移动操作字节来使某件事发生。

第二章 注释

2.1 单行注释

  • 独占一行的注释,用来解释下一行代码
    这行注释之前总是有一个空行,且缩进层级和下一行代码保持一致。
  • 在代码行的尾部的注释
    • 代码结束到注释之间至少有一个缩进。
    • 注释(包括之前的代码部分)不应当超过单行最大字符数限制,如果超过了,就将这条注释放置于当前代码行的上方。
  • 被注释掉的大段代码

2.2 多行注释

  • 多行注释前应有一个空行,且缩进层级和其描述的代码保持一致。
  • 星号后需要有空格
  • 代码尾部注释不要用多行注释格式

2.3 使用注释

在需要让代码变得更清晰时添加注释。

2.3.1 难于理解的代码

难于理解的代码通常都应当加注释。

2.3.2 可能被误认为错误的代码

当代码看上去有错误时,可添加注释提醒。

2.3.3 浏览器特性hack

做浏览器特性Hack的代码可能隐含一些错误,可添加注释。

2.4 文档注释

  • 所有的方法
    应当对方法、期望的参数和可能的返回值添加注释描述
  • 所有的构造函数
    应当对自定义类型和期望的参数添加注释描述
  • 所有包含文档化方法的对象
    如果一个对象包含一个或多个附带文档注释的方法,那么这个对象也应当适当地针对文档生成工具添加文档注释。

第三章 语句和表达式

所有的块语句都应当使用花括号

  • if
  • for
  • while
  • do...while...
  • try...catch...finally

for-in循环

最好使用hasOwnProperty()方法来为for-in循环过滤出实例属性。

第四章 变量函数

4.1 变量声明

变量声明是通过var语句来完成的。
变量声明提前意味着:在函数内部任意地方定义变量和在函数顶部定义变量是完全一样的。

  • 将局部变量的定义作为函数内第一条语句
  • 合并var语句

4.2 函数声明

函数声明也会被JavaScript引擎提前。

  • 先声明JavaScript函数然后使用函数。
  • 函数声明应当在条件语句的外部使用。

4.3 函数调用间隔

在函数名和左括号之间没有空格。

4.4 立即调用的函数

  (function () {
    // 函数体
  }())

4.5 严格模式

推荐使用严格模式use strict

4.6 相等

JavaScript具有强制类型转换机制

  • 推荐使用===!==
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

友情链接更多精彩内容