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

参考文章

目录
相关文章
|
2月前
|
JSON JavaScript 前端开发
如何使用代码注释:关于JavaScript与TypeScript
TSDoc是一种标准化TypeScript代码文档注释的规范,使不同工具能无干扰地提取内容。它包括多种标记,如@alpha、@beta等发布阶段标记;@decorator、@deprecated等功能标记;@defaultValue、@eventProperty等描述标记;@example、@experimental等示例与实验性标记;@inheritDoc、@internal等引用与内部标记;@label、@link等链接标记;@override、@sealed等修饰符标记;以及@packageDocumentation、@param、
48 5
|
5月前
|
JavaScript 前端开发
5.【TypeScript 教程】TypeScript Symbol
5.【TypeScript 教程】TypeScript Symbol
52 5
|
5月前
|
JavaScript 编译器
35.【TypeScript 教程】编译选项
35.【TypeScript 教程】编译选项
45 2
|
5月前
|
JavaScript 前端开发 C++
typescript 只读属性
typescript 只读属性
|
6月前
|
JavaScript 前端开发 编译器
如何编译Typescript文件?
如何编译Typescript文件?
|
6月前
|
JavaScript 前端开发 Java
小笔记:如何使用代码注释:关于JavaScript与TypeScript 注释和文档的自动生成
小笔记:如何使用代码注释:关于JavaScript与TypeScript 注释和文档的自动生成
564 0
|
6月前
|
JavaScript
解释如何使用 TypeScript 中的 mixin
解释如何使用 TypeScript 中的 mixin
57 0
|
JavaScript 前端开发 IDE
写好你的注释之 JSDoc
好的代码,注释肯定不能少,就目前而言基于 vue 的项目大部分都是使用的 vue2,vue2 相对于 ts 的支持没有那么完善,大部分包括我目前工作所在的团队,使用的 vue 版本都是采用 vue2
|
JavaScript 前端开发
TypeScript 笔记 TypeScript 中的 infer
本文介绍 TypeScript 中的 infer 及其使用方式。
119 0
|
JavaScript 前端开发 IDE
TypeScript的使用方法
TypeScript的使用方法
129 0
TypeScript的使用方法