最新下载
热门教程
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
javascript注释生成文档的代码
时间:2014-03-28 编辑:简简单单 来源:一聚教程网
后来发现这样的文档很不方便查看, 且又听我们BOSS说phper能生成他们的文档, 我在想js会不会也有一个呢, 于是...你懂的... 通过@广州♂lxrmido 知道了 jsdoc, 于是 github上down下来; 附地址: https://github.com/jsdoc3/jsdoc
他可以让你的js生成HTML文档,如:
代码如下 | 复制代码 |
/** for (var i in options) { |
使用 jsdoc 后可以解析成,文件,方法名,参数,例子,返回值作者等等信息,且有目录索引和源码..相当赞.如图:
word-spacing: 0px; padding-top: 0px; opacity: 0.9; box-shadow: rgb(204, 204, 204) 0px 0px 5px; border-top-left-radius: 4px; border-top-right-radius: 4px; border-bottom-right-radius: 4px; border-bottom-left-radius: 4px; -webkit-text-size-adjust: auto; -webkit-text-stroke-" alt='javascript注释生成文档的代码' src="https://img.111com.net/get_pic/2014/03/28/20140328121933469.png" />
且这只是她功能的冰山一角, 更多功能有待你的挖掘, 我也是刚刚知道, 不敢独藏, 于是分享!
注: 有什么问题可以回复啊, 大家一起研究/讨论
我是用node中的cnpm(npm大家都懂的)安装下
cnpm install jsdoc -g
然后用cmd进行需要的目录, 直接
jsdoc xl.js
//jsdoc 目录名
运行, 她会在同目录生成 out 文件夹, 然后你就打开吧. 注: 你的注释必须按标准走, 我用的sublime里的DocBlockr加的 ps:标准的注释会使我们以后的工作更帅气 更多参数说明请看 github, 或者 官网 http://usejsdoc.org/
-
上一个: phpcms用户上传头像漏洞的问题分析
相关文章
- HTML简单购物数量小程序代码展示 10-31
- html canvas实现弹幕功能 10-31
- HTML中空格表示的意义 10-31
- html area标签解读 10-31
- html使用表单标签实现注册页面代码展示 10-31
- 使用HTML截图并保存为本地图片的代码展示 10-31