【读书笔记】：《编写可维护的JavaScript》第02章注释

编写可维护的JavaScript

第02章注释
- 2.1 单行注释
- 2.2 多行注释
- 2.3 使用注释
- 2.4 文档注释

第02章注释

JavaScript支持两种不同类型的注释，单行注释和多行注释

2.1 单行注释

独占一行的注释，用来解释下一行代码。这行注释之前要有一个空行，且缩进层级和下一行的代码保持一致。
在代码行尾部的注释，代码结束到注释之间至少一个缩进。但该行的总长度不应该超过单行最大长度，如果超了，就将注释放到该行代码上方。
被注释掉的大段代码。这种情况不建议使用多行注释。

// 好的做法 注释前要有空行  注释要与被注释的代码相同缩进
if(con){// 如果代码执行到这里，。。。allowed();
}// 好的写法  注释写在代码后面时，要与代码之间有间隔
var result = something + somethingElse; // somethingElse不应当取值为null。// 好的做法 注释掉大段代码 要使用单行注释 不建议使用多行注释
// if(con){//  allowed();
// }

2.2 多行注释

多行注释可以包裹跨行文本。它以/开始/结束

/* 我是注释 */
/* 另一段注释 */

多行注释建议使用以下格式：

/** 多行注释* 该注释包含两行*/

2.3 使用注释

添加注释的一般原则：在需要让代码更清晰时添加注释
难于理解的代码
可能被误认为是错误的代码
浏览器特效hack

2.4 文档注释

如果想导出帮助文档API文件，那么就可以在方法或类的前面使用文档注释
文档注释有很多种格式，但最流行的一种格式来自于JavaDoc文档格式：多行注释以单斜线加双星号（/**）开始，
一般编辑器只要键入/**后enter回车就好

【读书笔记】：《编写可维护的JavaScript》第02章注释相关推荐

《编写可维护的JavaScript》——1.7　直接量
本节书摘来自异步社区<编写可维护的JavaScript>一书中的第1章,第1.7节,作者: [美]Nicholas C. Zakas 译者: 李晶 , 郭凯 , 张散集更多章节内容可以访 ...
读书笔记:《流畅的Python》第五章一等函数
# 一等对象/一等函数 ''' 1.在运行时创建 2.能赋值给变量或数据结构中的元素 3.能作为函数的参数传给函数 4.能作为函数的返回值返回结果 '''# 函数对象本身时function对象的实例d ...
读书笔记——《深入理解计算机系统》第三章_程序的机器级表示（一）
前言:已经大四,没有去找工作,选择了保研,之所以这样选择,有三个原因,一.刚进校时,听说保研都是牛人才能行的事,所以一心努力保研:二.2008年开始,经济危机比较严重,工作不好找,虽然软件专业要找一份 ...
【山外笔记-计算机网络·第7版】第02章：物理层
本文下载链接: [学习笔记]第02章_物理层-打印版.pdf 本章最重要的内容是: (1)物理层的任务. (2)几种常用的信道复用技术. (3)几种常用的宽带接入技术,主要是ADSL和FTTx. 一. ...
编写可维护的JavaScript之避免使用全局变量
一.避免全局变量的理由 js中避免创建全局变量一是避免命名冲突,二是避免因为创建全局变量让代码变得脆弱,三是创建全局变量会让代码难以测试. 二.避免创建全局变量的几种方法 //避免全局变量避免命名冲 ...
《编写可维护的Javascript》学习总结
第一部分一.基本规范 1.缩进:一般以四个空格为一个缩进. 2.语句结尾:最好加上分号,因为虽然"自动分号插入(ASI)"机制在没有分号的位置会插入分号,但是ASI规则复杂而且会 ...
编写可维护的javascript代码---开篇（介绍自动报错的插件）
文章开篇主要推荐了2款检测编程风格的工具: JSLint和JSHint: jsLint是由Douglas Crockford创建的.这是一个通用的javascript代码质量检测工具,最开始JSLin ...
编写可维护的javascript代码--- 2015.11.21（基本格式化）
1.1 每行的编码需要控制在80字符. 1.2 改用:的地方必须用上. 1.3 缩进用2个制表符,不过4个也可以. 1.4 当代码一行显示不全需要折行显示,这里我暂且假定缩进为4个字符. 1.5 如果 ...
读书笔记：《图解HTTP》第三章 HTTP报文
原文地址博客积累地址 HTTP报文的作用 HTTP报文时是HTTP进行请求和响应时用来交换信息的,可以理解它为搬东西的包裹,来搬运交换的信息报文流 HTTP报文在HTTP应用程序(客户端.服务器. ...

【读书笔记】：《编写可维护的JavaScript》第02章注释

编写可维护的JavaScript

第02章注释

2.1 单行注释

2.2 多行注释

2.3 使用注释

2.4 文档注释

【读书笔记】：《编写可维护的JavaScript》第02章注释相关推荐

最新文章

热门文章

【读书笔记】：《编写可维护的JavaScript》第02章 注释

编写可维护的JavaScript

第02章 注释

2.1 单行注释

2.2 多行注释

2.3 使用注释

2.4 文档注释

【读书笔记】：《编写可维护的JavaScript》第02章 注释相关推荐

最新文章

热门文章

【读书笔记】：《编写可维护的JavaScript》第02章注释

第02章注释

【读书笔记】：《编写可维护的JavaScript》第02章注释相关推荐