《编写可维护的JavaScript》——2.2 多行注释

简介: 管从技术的角度看,这些注释都是合法的,但我比较青睐Java风格的多行注释。Java风格的注释至少包含三行:第一行是/,第二行是以开始且和上一行的保持左对齐,最后一行是/。这种注释看起来像下面这样。

本节书摘来自异步社区《编写可维护的JavaScript》一书中的第2章,第2.2节,作者:【美】Nicholas C. Zakas著,更多章节内容可以访问云栖社区“异步社区”公众号查看

2.2 多行注释

多行注释可以包裹跨行文本。它以/开始,以/结束。多行注释不仅仅可以用来包裹跨行文本,这取决于你。下面这些都是合法的注释。

/* 我的注释 */
/* 另一段注释
这段注释包含两行 */
/*
又是一段注释
这段注释同样包含两行
*/

尽管从技术的角度看,这些注释都是合法的,但我比较青睐Java风格的多行注释。Java风格的注释至少包含三行:第一行是/,第二行是以开始且和上一行的保持左对齐,最后一行是/。这种注释看起来像下面这样。

/*
 * 另一段注释
 * 这段注释包含两行文本
 */

通过在注释块左侧注上星号,会让注释更加清晰。有一些IDE(比如NetBean和Eclipse)会为你自动插入这些星号。

多行注释总是会出现在将要描述的代码段之前,注释和代码之间没有空行间隔。和单行注释一样,多行注释之前应当有一个空行,且缩进层级和其描述的代码保持一致。来看下面这段例子。

// 好的写法
if (condition) {
     /*
      * 如果代码执行到这里
      * 说明通过了所有的安全性检测
      */
     allowed();
}
// 不好的写法:注释之前无空行
if (condition) {
     /*
      * 如果代码执行到这里
      * 说明通过了所有的安全性检测
      */
     allowed();
}
// 不好的写法:星号后没有空格
if (condition) {
     /*
      *如果代码执行到这里
      *说明通过了所有的安全性检测
      */
     allowed();
} 
// 不好的写法:错误的缩进
if (condition) {
/*
 * 如果代码执行到这里
 * 说明通过了所有的安全性检测
 */
     allowed();
}
// 不好的写法:代码尾部注释不要用多行注释格式
var result = something + somethingElse; /*somethingElse 不应当取值为null*/
相关文章
|
JavaScript
JS多行注释
JS多行注释
89 0
|
SQL JavaScript 前端开发
如何用 JavaScript 编写你的第一个单元测试
测试代码是确保代码稳定的第一步。能做到这一点的最佳方法之一就是使用单元测试....
如何用 JavaScript 编写你的第一个单元测试
|
前端开发 JavaScript
8 种技巧让你编写更简洁的 JavaScript 代码
8 种技巧让你编写更简洁的 JavaScript 代码
261 0
8 种技巧让你编写更简洁的 JavaScript 代码
|
机器学习/深度学习 Web App开发 JavaScript
用JavaScript编写Chip-8模拟器
我相信大多数人都用模拟器玩过游戏吧!比如GBA模拟器,PSP模拟器,NES模拟器等。所以应该也有人会跟我一样想自己写个游戏机模拟器。但这些模拟器对于一个新手来说难度太大了,就比如NES模拟器中CPU的指令就有100个以上了,更别说除了CPU还有显卡之类的东西需要模拟。
1213 0
|
JavaScript 前端开发
PubSubJS:用JavaScript编写的基于主题的发布/订阅库
PubSubJS:用JavaScript编写的基于主题的发布/订阅库
203 0
|
JavaScript 前端开发 测试技术
【Javascript】学习使用mocha(摩卡)编写测试用例-常用命令
【Javascript】学习使用mocha(摩卡)编写测试用例-常用命令
119 0
|
Web App开发 JavaScript 前端开发
|
JavaScript 前端开发
编写可维护的JavaScript
软件生命周期中80%的成本都消耗在了维护上;而且几乎所有的维护者都不是代码的直接开发人。如何让自己写的代码让别人阅读起来更高效?当然是写代码的时候注入一些规范。那么在Javascript中有哪些编程风格值得我们去注重呢?这篇文章将总结《编写可维护的JavaScript》里面的观点。
1405 0
|
SQL JavaScript 前端开发
javascript + sql编写SQL客户端工具tabris
祝大家2018新年快乐, 前不久发现了一个创意的脚本JtSQL(java编写) 开源地址为:https://github.com/noear/JtSQL JtSQL 特点:*.结合了JS、SQL、模板理念;*.
1109 0
|
JavaScript 前端开发 API
JavaScript插件编写指南
在编写插件之前,大家要先了解做插件的几个要点: 插件需要满足的条件 一个可复用的插件需要满足以下条件: 插件自身的作用域与用户当前的作用域相互独立,也就是插件内部的私有变量不能影响使用者的环境变量; 插件需具备默认设置参数; 插件除了具备已实现的基本功能外,需提供部分API,使用者可以通过该API修改插件功能的默认参数,从而实现用户自定义插件效果; 插件需提供监听入口,及针对指定元素进行监听,使得该元素与插件响应达到插件效果; 插件支持链式调用。
1022 0