文档章节

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

adbug
 adbug
发布于 2016/05/15 16:51
字数 456
阅读 286
收藏 6

 

 

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
博文 176
码字总数 198249
作品 0
成都
打造属于自己的前端开发神器 -- 给Sublime Text加上Eclipse的光环

打造属于自己的前端开发神器 -- 给Sublime Text加上Eclipse的光环 2013-05-16 14:39:15 将Sublime Text打造成如Eclipse一般的前端开发IDE 1. 快捷键移植篇 从Java开始的梦, 到如痴如醉的Fro...

niceguy_php
2014/07/07
0
2
前端神器-神级代码编辑软件Sublime Text下载、使用教程、插件推荐说明、全套快捷键

Sublime Text 是一个代码编辑器,也是HTML和散文先进的文本编辑器。Sublime Text是由程序员Jon Skinner于2008年1月份所开发出来,它最初被设计为一个具有丰富扩展功能的Vim。 Sublime Text具...

NET快速开发框架
07/19
0
0
Ubuntu 14.04 Sublime Text 3

via:https://sublime.wbond.net/ 操作参考:http://feliving.github.io/Sublime-Text-3-Documentation/index.html Package Control via:https://sublime.wbond.net/installation ConvertToU......

杯面柒
2014/05/02
0
4
如何优雅地使用Sublime Text

Sublime Text:一款具有代码高亮、语法提示、自动完成且反应快速的编辑器软件,不仅具有华丽的界面,还支持插件扩展机制,用她来写代码,绝对是一种享受。相比于难于上手的Vim,浮肿沉重的E...

jeffjade
2015/12/15
0
0
Sublime Text 2 快捷键 (windows)

Sublime Text 2 快捷键 (windows) 今天把windows版 Sublime Text 2 快捷键 整理了出来,与众兄弟们分享: Ctrl+L 选择整行(按住-继续选择下行) Ctrl+KK 从光标处删除至行尾 Ctrl+Shift+K 删...

David_Tio
2013/12/05
0
0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

Zookeeper总结

Zookeeper的部分概念 什么是zookeeeper? Zookeeper是一个分布式服务的协调中心 zookeeper节点的角色类型? Leader(领导者)、Follower(跟随者)、Observer(观察者) Leader 负责更新系统...

DemonsI
12分钟前
0
0
Redis学习笔记

常用命令 从Docker进入Redis的命令 sudo docker exec -it redis /bin/bash

OSC_fly
12分钟前
0
0
SqlServer查询某个日期的数据

select * from View_ZJMONITORINGCORROSION where ENTERDATE > CONVERT(datetime,DATEADD(day,1,'2017/12/28 14:53:07'))...

笑丶笑
13分钟前
0
0
常用编码规范

Standard characters https://ascii.cl/

yeahlife
15分钟前
0
0
flannel实战

docker swarm mode的出现是个里程碑,官方原生的编排调度看起来都成雏形了,但是swarm mode和容器外部系统的对接、网络性能始终不尽人意,swarm mode下各种开源周边不能使用,感觉swarm mod...

China_OS
17分钟前
0
0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部