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/,该单词的意思是犀牛。

参考文章

目录
相关文章
|
11月前
|
分布式计算 JavaScript 前端开发
【JavaScript】JS 函数式编程入门指南:从概念到实践 (三)
【JavaScript】JS 函数式编程入门指南:从概念到实践 (三)
|
JavaScript 前端开发 IDE
写好你的注释之 JSDoc
好的代码,注释肯定不能少,就目前而言基于 vue 的项目大部分都是使用的 vue2,vue2 相对于 ts 的支持没有那么完善,大部分包括我目前工作所在的团队,使用的 vue 版本都是采用 vue2
|
11月前
|
人工智能 IDE 前端开发
这 12 个基于 AI 的 VSCode “杀手级” 生产力插件,了解一下?(一)
这 12 个基于 AI 的 VSCode “杀手级” 生产力插件,了解一下?(一)
|
机器学习/深度学习 存储 文字识别
图解来啦!机器学习工业部署最佳实践!10分钟上手机器学习部署与大规模扩展 ⛵
如何快速部署机器学习模型?本文是机器学习工业部署的 best practice(最佳实践)!详细讲解了如何操作机器学习开源框架 BentoML,帮助研发团队轻松打包机器学习模型,并重现该模型以用于生产。
1575 4
图解来啦!机器学习工业部署最佳实践!10分钟上手机器学习部署与大规模扩展 ⛵
|
11月前
|
Web App开发 前端开发 数据可视化
【重学CSS】图文并茂!一次性搞懂 Grid 布局,实现“布局自由”~(上)
【重学CSS】图文并茂!一次性搞懂 Grid 布局,实现“布局自由”~(上)
|
11月前
|
设计模式 安全 Java
【鸟瞰】C#的学习
前言: 在软件工程之C/S学习的过程中,我们已经学习过了软件工程,文档,九种UML图。下一个学习小阶段是C#和设计模式,视频里的老师上来就讲“.NET”,还说应该念成“dot Net”,念成“点NET”实在是太不专业了。我突然有点蒙圈了,为啥在这个阶段要学习C#?学C#为啥还和“dot Net”有关?怎么这么多C?什么C语言?C ++?C#?这些都是些什么鬼?晕!!! 于是开始在培养计划中寻找答案。。。
|
12月前
|
Shell
shell脚本学习(日志格式化输出)
shell脚本学习(日志格式化输出)
345 0
|
JSON 缓存 前端开发
搭建前端组件库文档最佳姿势:Docz
搭建前端组件库文档最快姿势:Docz
|
JavaScript 前端开发
js: Math.random()获取随机数
js: Math.random()获取随机数
64 0
|
JavaScript 前端开发