编写可维护的javascript代码--- 2015.11.22(注释)
1.单行注释
// 这是一句单行注释
2.多行注释
/* 这里是代码 */
/*
这里都是注释
1232132
*/
java的注释风格
/*
* 另一段注释
* 这段注释包含2个文本
*/
3 文档注释
/**
* @method merge
* @param {Object} 被合并的一个或多个对象
* @return {Object} 一个新的被合并后的对象
**/
这里推荐大家一个地址,大家可以去看一看 点击查看注释大全
Sublime注释插件-DocBlockr
功能
生成优美注释
简介
标准的注释,包括函数名、参数、返回值等,并以多行显示,省去手动编写
wiki
使用方法
1.快速注释: 输入/*、/**(在Coffee-Script中是###*),Enter
2. 函数注释:使用Tab在不同的字段切换
3. 变量注释
4. 注释+评论