`
- 浏览:
8207 次
- 性别:
- 来自:
北京
-
Javascript文档生成是比较头疼的问题,不过现在已经有开源的工具可以使用——JsDoc。
其官方站点地址:http://jsdoc.sourceforge.net/
Release版的下载地址是:http://sourceforge.net/projects/jsdoc
JsDoc是根据Javascript代码中的注释生成相应的帮助文档,它定义了一套注释标签规范。因此在编写Javascript代码时,要根据它能识别的注释标签进行注释。
具体使用方法如下:
1、如果操作系统是windows的用户,需要配置perl环境,推荐安装ActivePerl ,Linux/Unix用户则不用配置了。
2、解压缩JsDoc,在命令提示窗口中进入JsDoc所在目录,使用如下命令即可生成Javascript代码的文档。
perl jsdoc.pl test.js
其中test.js是用于测试的js文件,如果成功则在该目录下生成js_docs_out目录,里面包含生成的文档。
3、如果生成失败,产生如下错误信息:
Can't locate HTML/Template.pm in @INC ......
需要配置HTML::Template模块,配置方法为:
进入perl的Package Manager,可以使用命令ppm,也可以点击开始菜单——ActivePerl 5.8.8 Build 817——Perl Package Manager。然后使用install命令安装HTML::Template模块,代码如下:
C:\> ppm
PPM> install HTML-Template
PPM> quit
具体的参数及用法可以查看JsDoc的官方网站。
转自网上
分享到:
Global site tag (gtag.js) - Google Analytics
相关推荐
dox - 针对node的JavaScript文档生成器使用markdown和jsdoc
为JavaScript生成类似与Java Doc的文档。
NULL 博文链接:https://jsrookie.iteye.com/blog/294761
Markdown javascript 文档生成器 开始吧 var mox = require ( "mox" ) ; var source = "./source1.js" ; mox . run ( source1 ) . pipe ( process . stdout ) => //outputs markdown data ##目的 该项目允许为 ...
多克斯 Doxv 是一个基于的 JavaScript 文档生成器。 它为您的组件可视化 API 和 Markdown 文件。安装 $ npm install -g doxv用法该示例展示了如何为 doxv 本身生成文档。 $ git clone ...
用于使用Gulp 插件(降价 javascript 文档生成器) 应在 mox上报告输出。* 安装 $ npm install --save-dev gulp-mox 用法 var gulp = require ( 'gulp' ) ; var mox = require ( 'gulp-mox' ) ; gulp . task ( '...
多克斯 Dox是一个用编写JavaScript文档生成器。 Dox不再为文档生成确定的结构或样式,它只是为您提供JSON表示形式,使您可以使用markdown和JSDoc -style标记。安装从npm安装: $ npm install -g dox使用范例dox(1)在...
jdi - 一个JavaScript的文档生成器
受启发的文档生成器。 Doxxo 解析 JavaScript 代码中的块级注释以查找文档并将它们解析为 Markdown。 Doxxo 目前仅支持 JavaScript 和 Markdown 文件。 查看,由 Doxxo 本身生成! 安装 $ npm install -g doxxo ...
JavaScript在线API文档生成.doc
本源码提供了一个基于JavaScript的docsify文档网站生成器设计。项目包含180个文件,其中包括103个JavaScript文件、34个Markdown文档、9个JSON文件、7个Stylus文件、5个YAML文件、3个PNG图片、3个HTML文件、3个SVG...
Dgeni-文档生成器 由angular.js和其他项目提供的node.js文档生成实用程序。 Dgeni的发音类似于女孩名Jenny( ),即d是无声的而g是柔和的。入门试用Dgeni。 或者,也许您正在寻找的示例。 观看Pete在Dgeni上的ng-...
ESDoc - 是JavaScript的API文档生成器
JavaScript在线API文档生成文献综述.doc
JavaScript在线API文档生成毕业设计正文.doc
Doczar (发音 dozer) 是一款简单,明确的文档生成器,支持 JavaScript,Python,Ruby,Java,C 类型的语言等等。 Doczar 并不会从源代码直接生成稳定,只需要使用标记的注释。注释格式简约大方,易读,使用一个简单...
-dox 一饮而尽-DOX插件 用法 首先,安装gulp-dox作为开发依赖项: npm install --save-dev gulp-dox 然后,将其添加到您的gulpfile.js : var dox = require ( "gulp-dox" ) ; gulp .... return gulp ....
javascript在线api文档生成文献-综述设计论文.doc
这些文件详细展示了如何使用Java、HTML、CSS和JavaScript构建一个智能文档生成工具,该工具支持Java RESTful API和Apache Dubbo RPC接口文档的生成,完全基于注释生成文档,做到零侵入。这些文件非常适合用于学习和...