jsDoc的使用

简介: nodeJS使用: 直接:npm install jsdoc -g使用:jsdoc [name].js 简介 JsDoc Toolkit 是一款辅助工具,你只需要根据约定在 JavaScript 代码中添加相应的注释,它就可以根据这些注释来自动生成API文档。

nodeJS使用:

直接:npm install jsdoc -g
使用:jsdoc [name].js

简介

JsDoc Toolkit 是一款辅助工具,你只需要根据约定在 JavaScript 代码中添加相应的注释,它就可以根据这些注释来自动生成API文档。对Java 熟悉的人可能会发现它和 Java 的文档自动化工具 JavaDoc 很像,没错,JsDoc Toolkit 就是基于 JavaDoc 开发的。

下载地址

http://code.google.com/p/jsdoc-toolkit/

目录结构

  • app : 存放的是js文件。包括一些实例文件和读取js和模板生成文档的js文件。
  • conf : 提供默认的配置的文件。
  • java : 存放的是“rhino”这是一个脚本java写的javascript脚本引擎,用来提供js的运行环境。
  • templates : 存放生成文档的模板,根据不同的模板可以生成html xml等各种类型文档。
  • jsrun.jar,jsdebug.jar : 生成的入口调用了rhino框架和js文件

工作模式

通过一段java代码(jsrun.jar)调用rhino框架(该框架提供了一个运行javascript的环境),然后再运行javascript读取生成文档的javascript文件和模板文件生成文档。

注释标签

这里的标签是指约定的注释标签,只有写了这些标签, JsDoc Toolkit 才能根据这些标签来生成正确的文档,比如在 @example 之后跟一段小的代码例子。

可用标签列表:http://code.google.com/p/jsdoc-toolkit/wiki/TagReference

使用

首先切换到当前目录下,windows执行下面命令

> java -jar jsrun.jar app\run.js -a -t=templates\jsdoc mycode.js

Mac OS或Linux执行西面命令

$ java -jar jsrun.jar app/run.js -a -t=templates/jsdoc mycode.js

如果成功的话,你就会看到当前文件夹里多出了一个叫做 out 的文件夹,生成的文档就在里面了!然后你就可以在浏览器中查看了。

说明:

  • “java -jar jsrun.jar app/run.js” :固定代码,每次运行时都必须含有的。
  • -a 或者 –allfunctions :为全部函数生成文档,包括那些没有写注释的。
  • -c 或者 –conf :使用配置文件
  • -d= 或者 –directory=:指定生成文档的输出目录,默认是 “out”
  • -e= 或者 –encoding=:指定编码方式
  • -n 或者 –nocode :忽略所有代码,只为有 @name 标签的注释生成文档。
  • -o= 或者 –out= : 将日志信息输出到指定文件
  • -q 或者 –quiet : 不输出任何信息,包括警告。
  • -t= 或者 –template= :指定文档的模板,这个参数必须提供

查看帮助

$ java -jar jsrun.jar app/run.js --help
	

Rhino

Mozilla's Rhino JavaScript runtime engine.官网:http://www.mozilla.org/rhino/,该单词的意思是犀牛。

参考文章

目录
相关文章
|
前端开发 Java 应用服务中间件
在Spring Boot中配置web app
在Spring Boot中配置web app
|
JavaScript 前端开发
css:隐藏input file标签并触发点击上传文件事件
css:隐藏input file标签并触发点击上传文件事件
812 0
css:隐藏input file标签并触发点击上传文件事件
|
JavaScript
【异常】$ is not defined (已解决)
$ is not defined (已解决),F12调试页面Console错误提示
268 0
|
机器学习/深度学习 缓存 算法
语音评测技术在古文背诵中的应用
语音评测技术和语音识别任务非常类似,近些年都获得了快速发展,语音识别中各种端到端算法不仅简化了训练流程,同时降低了整体错误率。评测技术也从原来的 HMM-GMM 升级到 HMM-DNN,准确率大幅提升。
724 1
语音评测技术在古文背诵中的应用
|
开发工具
静态IP设置(超详细)
静态IP设置(超详细)
748 0
静态IP设置(超详细)
|
编解码 C#
C#(三十八)之StreamWriter StreamWriter使用方法及与FileStream类的区别
本篇内容记录了StreamReader类的属性和方法、StreamWriter类的属性和方法等
533 0
C#(三十八)之StreamWriter StreamWriter使用方法及与FileStream类的区别
|
Java 索引
模板引擎Velocity
Velocity是一个基于Java的模板引擎,可以通过特定的语法获取在java对象的数据 , 填充到模板中,从而实现界面和java代码的分离 !
|
Rust 算法 安全
【密码学】一文读懂随机数
本文简单的介绍了一下随机数的概念,然后给出了一个非密码学安全的随机数生成器--线性同余法,一定注意,这个方法不要用在密码学相关用途蛤。
【密码学】一文读懂随机数
|
JavaScript 前端开发 .NET
一起谈.NET技术,ASP.NET前台代码绑定后台变量方法总结
  经常会碰到在前台代码中要使用(或绑定)后台代码中变量值的问题。一般有和两种方式,这里简单总结一下。如有错误或异议之处,敬请各位指教。   一方面,这里所讲的前台即通常的.aspx文件,后台指的是与aspx相关联的CodeBehind,文件后缀名为.aspx.cs;另一方面,这里的绑定是指用户发出访问某一页面指令后,服务器端在执行过程中就已经将前台代码进行了赋值,而后生成html格式回传客户端显示,而并非已经显示到客户端后,然后通过其他方法(如ajax)去服务器端获取相应变量。
1488 0