文档章节

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

adbug
 adbug
发布于 2016/05/15 16:51
字数 456
阅读 336
收藏 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
15 款炫酷的 Sublime Text 插件推荐

Sublime Text 是目前最受欢迎的代码编辑器,因其高效、简洁和插件丰富等特点受到开发者的喜爱。 为了帮助大家充分利用 Sublime 的优势,本文筛选了开发者日常使用较多的 15 款 Sublime Text...

oschina
2017/05/03
11.7K
16
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 2 快捷键 (windows)

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

David_Tio
2013/12/05
0
0

没有更多内容

加载失败,请刷新页面

加载更多

Ubuntu18.04 安装MySQL

1.安装MySQL sudo apt-get install mysql-server 2.配置MySQL sudo mysql_secure_installation 3.设置MySQL非root用户 设置原因:配置过程为系统root权限,在构建MySQL连接时出现错误:ERROR...

AI_SKI
今天
2
0
3.6 rc脚本(start方法) 3.7 rc脚本(stop和status方法) 3.8 rc脚本(以daemon方式启动)

3.6-3.7 rc脚本(start、stop和status方法) #!/usr/bin/env python# -*- coding: utf-8 -*-# [@Version](https://my.oschina.net/u/931210) : python 2.7# [@Time](https://my.oschina.......

隐匿的蚂蚁
今天
3
0
Cnn学习相关博客

CNN卷积神经网络原理讲解+图片识别应用(附源码) 笨方法学习CNN图像识别系列 深度学习图像识别项目(中):Keras和卷积神经网络(CNN) 卷积神经网络模型部署到移动设备 使用CNN神经网络进行...

-九天-
昨天
4
0
flutter 底部输入框 聊天输入框 Flexible

想在页面底部放个输入框,结果键盘一直遮住了,原来是布局问题 Widget build(BuildContext context) { return Scaffold( appBar: AppBar( title: Text("评论"), ...

大灰狼wow
昨天
4
0
Kernel I2C子系统

备注:所有图片来源于网络 1,I2C协议: 物理拓扑: I2C总线由两根信号线组成,一条是时钟信号线SCL,一条是数据信号线SDA。一条I2C总线可以接多个设备,每个设备都接入I2C总线的SCL和SDA。I...

yepanl
昨天
5
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部