文档章节

sublime text 3 插件:DocBlockr与javascript注释规范

adbug
 adbug
发布于 2016/05/15 16:51
字数 456
阅读 266
收藏 6
点赞 2
评论 0

 

 

1、引子

在写代码的时候,尤其是写脚本,最需要注释了。目前脚本、样式的注释格式都有一个已经成文的约定规范(这些约定规范最初是YUI Compressor制定的,详见参考资料)了,如下:

/**
 * 这里的注释内容【会】被压缩工具压缩
 */

/*!
 * 这里的注释内容【不会】被压缩工具压缩
 * 与上面一个注释块不同的是,第2个*换成了!
 */

其中说到这里说到的压缩工具有fYUI Compressor 、fGoogle Closure Compilerfgulp-uglifyfgrunt-contrib-uglify等,这些压缩工具都支持以上的压缩约定。常常把文件的关键信息放在第2种注释内容里,如文件名称、版本号、作者等。

关于这些关键信息,都有一些关键词和一定的格式来书写。关键词书写格式为:

/**
 * @author ydr.me
 * @version 1.0
 */

使用@key desc格式来书写,常用的关键词有:

关键词 描述
@auhor 作者
@param 参数
@example 示例
@link 链接
@namespace 命名空间
@requires 依赖模块
@return 返回值
@version 版本号

其中,param关键词的格式为:

/**
 * @param {String} 参数描述
 */

2、插件

使用package control安装DocBlockr。安装完成后使用方法如下:

A、先写完你的函数

function testFunction(a, b, c) {

}

B、然后在函数的前面一行,输入

/**

C、然后回车,自动生成

/**
 * [testFunction description]
 * @param  {[type]} a [description]
 * @param  {[type]} b [description]
 * @param  {[type]} c [description]
 * @return {[type]}   [description]
 */
function testFunction(a, b, c) {

}

D、并且在注释块中,按@键可以展开关键词:

img.png

3、参考资料

© 著作权归作者所有

共有 人打赏支持
adbug
粉丝 6
博文 75
码字总数 198249
作品 0
成都
8款实用Sublime text 3插件推荐

Sublime Text作为一个尽为人知的代码编辑器,其优点不用赘述。界面整洁美观、文本功能强大,且运行速度极快,非常适合编写代码,写文章做笔记。Sublime Text还支持Mac、Windows和Linux各大平...

slagga ⋅ 04/16 ⋅ 0

全栈开发必备的10款Sublime Text 插件

全栈开发必备的10款Sublime Text 插件 来源:梦想天空博客园 时间:2014-11-28 10:16:28 阅读数:218406 分享到:6 [导读] Sublime Text 具有漂亮的用户界面和强大的功能,例如代码缩略图,多...

thinkyoung ⋅ 2015/11/05 ⋅ 0

一站式手把手教你学习Sublime Text 3(插件安装、html/css速写、输入法不根随光标)

Sublime Text 是一款流行的代码编辑器软件,也是HTML和散文先进的文本编辑器,可运行在Linux,Windows和Mac OS X。也是许多程序员喜欢使用的一款文本编辑器软件。下面就重点介绍一下Sublime...

明成51xit ⋅ 04/26 ⋅ 0

Sublime Text 3.1发布! 如何在Ubuntu 18.04中安装

Sublime Text 3.1发布! 如何在Ubuntu 18.04中安装 IMCN 20分钟前暂无评论 阅读 9 次 Sublime Text源代码编辑器3.1几天前发布,对DPI支持进行了大量改进。 Sublime Text 3.1发布亮点: Wind...

IMCN ⋅ 05/12 ⋅ 0

Sublime-Text3 的安装与使用

Sublime-Text3 的安装与使用 Sublime-Text3 的安装与使用 01.Sublime-Text3介绍 Sublime-Text 是一个比较强大的代码,文本编辑器。它的强大之处可以总结以下: 1.可扩充性:你可以根据自己的需...

meiqi0538 ⋅ 05/03 ⋅ 0

Java程序员最喜爱的编辑器之一(Sublime Text 3)

Hello,大家好!我是Rain。今天给大家推荐一款程序员最心仪的编辑器之一——Sublime Text 3。为什么说它是程序员最喜欢的编辑器呢?答案就是它漂亮的用户界面以及强大的功能。下面我给大家详...

仵宁飞 ⋅ 06/09 ⋅ 0

跨平台编辑器 - Visual Studio Code

Visual Studio Code 是一个运行于 OS X,Windows 和 Linux 之上的,针对于编写现代 Web 和云应用的跨平台编辑器。 这标志着 Microsoft 第一次向开发者们提供了一款真正的跨平台编辑器。虽然完...

匿名 ⋅ 2015/07/07 ⋅ 17

Sublime Text 3 (支持v3143)最新版破解及注册码

Sublime Text 是一个代码编辑器(Sublime Text 3是收费软件,但可以无限期试用),也是HTML和散文先进的文本编辑器。Sublime Text 3 在2013年1月29日进入测试版本。起初仅开放给已购买 Subl...

我是李达康 ⋅ 2015/09/13 ⋅ 20

Sublime Text 2/3 输入法(Fcitx)修复[Ubuntu(Debian)]

文章目录 主要目的 更新 注意 使用方法 主要目的 安装 Sublime Text 3 安装 Fcitx 输入法 + 皮肤 修复 Sublime Text 2/3’s 在 Ubuntu(Debian) 系统下的无法输入中文(CJK 字符)输入法的问题 ...

John ⋅ 06/15 ⋅ 0

Ubuntu,sublime的安装和配置中文输入

系统:Ubuntu 16.04 输入法:fcitx 拼音五笔 官网下载页: 安装 本想添加软件源到apt ,但是sublime的网站貌似被墙了。添加不成功。老是链接失败。只好下载安装包,自己手动安装了。 官网的安...

ol_O_O_lo ⋅ 05/17 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

Cube、Cuboid 和 Cube Segment

1.Cube (或Data Cube),即数据立方体,是一种常用于数据分析与索引的技术;它可以对原始数据建立多维度索引。通过 Cube 对数据进行分析,可以大大加快数据的查询效率 2.Cuboid 在 Kylin 中特...

无精疯 ⋅ 38分钟前 ⋅ 0

github太慢

1:用浏览器访问 IPAddress.com or http://tool.chinaz.com 使用 IP Lookup 工具获得github.com和github.global.ssl.fastly.net域名的ip地址 2:/etc/hosts文件中添加如下格式(IP最好自己查一...

whoisliang ⋅ 40分钟前 ⋅ 0

非阻塞同步之 CAS

为解决线程安全问题,互斥同步相当于以时间换空间。多线程情况下,只有一个线程可以访问同步代码。这种同步也叫阻塞同步(Blocking Synchronization). 这种同步属于一种悲观并发策略。认为只...

长安一梦 ⋅ 50分钟前 ⋅ 0

云计算的选择悖论如何对待?

人们都希望在工作和生活中有所选择。但心理学家的调查研究表明,在多种选项中进行选择并不一定会使人们更快乐,甚至不会产生更好的决策。心理学家Barry Schwartz称之为“选择悖论”。云计算为...

linux-tao ⋅ 53分钟前 ⋅ 0

我的第一篇个人博客

虽然这是个技术博客,但是,我总是想写一些自己的东西,所有就大胆的在这里写下了第一篇非技术博客。技术博客也很久没有更新,个人原因。 以后自己打算在这里写一些非技术博客,可能个人观点...

Mrs_CoCo ⋅ 54分钟前 ⋅ 0

Redis 注册为 Windows 服务

Redis 注册为 Windows 服务 redis 注册为 windows 服务相关命令 注册服务 redis-server.exe –service-install redis.windows.conf 删除服务 redis-server –service-uninstall 启动服务 re......

Os_yxguang ⋅ 54分钟前 ⋅ 0

世界那么大,语言那么多,为什么选择Micropython,它的优势在哪?

最近国内MicroPython风靡程序界,是什么原因导致它这么火呢?是因为他功能强大,遵循Mit协议开源么? 错!因为使用它真的是太舒服了!!! Micropython的由来,这得益于Damien George这位伟大...

bodasisiter ⋅ 57分钟前 ⋅ 0

docker 清理总结

杀死所有正在运行的容器 docker kill $(docker ps -a -q) 删除所有已经停止的容器(docker rm没有加-f参数,运行中的容器不会删掉) docker rm $(docker ps -a -q) 删除所有未打 dangling 标...

vvx1024 ⋅ 今天 ⋅ 0

关于学习

以前学车的时候,教练说了这样的一句话:如果一个人坐在车上一直学,一直学,反而不如大家轮流着学。因为一个人一直学,就没有给自己留空间来反思和改进。而轮流着学的时候大家下来之后思考上...

mskk ⋅ 今天 ⋅ 0

压缩工具之gzip-bzip2-xz

win下常见压缩工具:rar zip 7z linux下常见压缩工具:zip gz bz2 xz tar.gz tar.bz2 tar.xz gzip 不支持目录压缩 gzip 1.txt #压缩。执行后1.txt消失,生成1.txt.gz压缩文件 gzip -d 1.txt....

ZHENG-JY ⋅ 今天 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部