常用工具说明--jsdoc 前端文档输出工具

1.利用npm安装jsdoc模块

npm install jsdoc -g

2.由于jsdoc默认的生成文档模板不好看，可以下载一套好看些的模板，如 jaguar.js

下载地址：https://github.com/davidshimjs/jaguarjs-jsdoc

也可用npm下载

3.将node_modules/jsdoc/templates/default下面的内容删除掉，然后将第二步下载的全部内容放在里面

4.创建jsdoc的配置文件

建立一个conf.json

{

"tags": {

"allowUnknownTags": true

"source": {

"include": ["lib"],

"includePattern": ".+\\.js(doc)?$",

"excludePattern": "(^|\\/|\\\\)_"

"templates": {

"cleverLinks": true,

"monospaceLinks": true,

"default": {

"outputSourceFiles" : true

"applicationName": "demo",

"openGraph": {},

"meta": {}

}

保存在根目录下。

5.cmd下输入 jsdoc -c conf.json，生成的out文件夹就是文档生成的位置。

JSDoc中文文档：http://www.css88.com/doc/jsdoc/about-configuring-default-template.html

转载于:https://www.cnblogs.com/tanwei81/p/8822074.html

常用工具说明--jsdoc 前端文档输出工具相关推荐

php编写文件管理工具,php之markdown文档管理工具的实现代码
本文主要和大家分享php之markdown文档管理工具的实现代码,希望能帮助到大家. 主要目标: 1.可以多人编辑 2.可以在浏览器中查看 3.有一个可以折叠的目录 4.支持多级目录 5.支持mark ...
工具篇—《MD文档辅助工具，PicGo使用》
MD文档辅助工具,PicGo使用一.概念二.配置教程 1. 安装PicGo 2.Typora配置 3.常见错误 1.failed to fetch 2.上传失败三.设置GitHub图床四.设置 ...
JSDoc入门使用指南 -- 手摸手教你用JSDoc（超好用的js文档生成工具）
安装准备 Node.js 8.15.0+ 通过npm安装全局安装:npm install -g jsdoc 若出现权限问题,如 EACCES报错,最佳实践为用node版本管理器(nvm等)重装np ...
Database-doc 数据库文档展示工具
实用工具 Database-doc:数据库文档展示工具简介数据库文档展示工具(Database-doc),又叫数据库注释浏览工具,是一个简单的数据库展示各个字段注释的开源工具.在日常开发工作中,您 ...
一款常用文档生成工具：Doxygen
关注+星标公众号,不错过精彩内容来源 | 简书编排 | strongerHuang 程序员的很多文档,特别是有代码的文档,绝大部分都是由一款文档生成工具[Doxygen]生成. 什么是Doxyge ...
jsdoc api文档_创建更好的JSDoc文档
jsdoc api文档 Writing code documentation is one of the most relaxing experiences of my work as a back ...
java 接口文档工具_一款Java基于注释的接口文档生成工具
一. 痛点你还在手动维护接口文档嘛,花一个下午不停的复制粘贴代码里面的注释接口字段变动,还得去更新文档,更新不及时导致文档不同步或者你使用了swagger之类的基于注解,依靠运行时的文档工具,看 ...
简要介绍word文档转换为pdf格式文档的工具
找了很多工具,其实都是乱七八糟的,没几个好用的,最好还是用Adobe Acrobat Pro吧,这个就很方便了,而且转换的也不错. ABC Amber PDF Converter ABC Amber ...
python docx 合并文档图片_MBT文档模型化生成工具——30倍效率文档撰写工程化方法...
MBT(A model based document builder)文档模型化生成工具用户手册--30倍效率文档撰写工程化方法 1 简介在软件工程领域,工程文档通常主要包括实施方案.需求分析.软件 ...

常用工具说明--jsdoc 前端文档输出工具

常用工具说明--jsdoc 前端文档输出工具相关推荐

最新文章

热门文章