JavaScript的API文档自动生成工具jsdoc

一、概述:jsdoc是JavaScript的API文档自动生成工具

二、非项目中使用:

1、全局安装jsdoc


npm install -g jsdoc

2、创建js ,命名为2.js,内容如下:


/*** HelloWorld类存储一位客人的名字，并打招呼。*/
class HelloWorld {constructor(){this.firstName = '';this.lastName = '';}/*** 设置客人的姓名** @param {String} lastName 姓* @param {String} firstName 名*/setName(lastName, firstName){this.lastName = lastName;this.firstName = firstName;}/*** 获取客人的全名** @return {String} 客人的姓名*/getFullName(){return this.lastName + ' ' + this.firstName;}/*** 向客人打招呼**/sayHello(){console.log('Hello, ' + this.getFullName());}
}

3、使用jsdoc自动生成文档:

jsdoc 2.js

4、使用上述命令，自动生成out文件，运行文件中的index.html

三、项目中使用:

1、创建项目project-test

cd Desktop
mkdir project-test
cd project-test
npm init -y          -----自动生成package.json文件

2、全局安装jsdoc

npm install -g jsdoc

3、项目中安装jsdoc

npm install --save-dev jsdoc

4、创建js ,命名为2.js,内容如下

     this.lastName = '';}/*** 设置客人的姓名** @param {String} lastName 姓* @param {String} firstName 名*/setName(lastName, firstName){this.lastName = lastName;this.firstName = firstName;}/*** 获取客人的全名** @return {String} 客人的姓名*/getFullName(){return this.lastName + ' ' + this.firstName;}/*** 向客人打招呼**/sayHello(){console.log('Hello, ' + this.getFullName());}
}

5、使用jsdoc自动生成文档:

jsdoc 2.js

6、使用上述命令，自动生成out文件，运行文件中的index.html

JavaScript的API文档自动生成工具jsdoc相关推荐

Java api文档自动生成工具smartdoc+torna
首先,一般做java服务端都用过postman,并且都写过前端调用的api文档接口,并且也用过市面上的一些工具. API自文档动生成,能够省去了写文档的时间. 当然,当前也会有很多类似的开源工具,我们 ...
API文档自动生成的方法
编写API文档是API编写人员的噩梦,而API文档通常是由API研发人员编写.由于API文档创建繁琐,需要记录的内容比较广,结束了API开发任务后,还要仔细编写API文档,给研发人员带来额外的工作量. ...
java如何生成api文档_api文档自动生成工具
java开发,根据代码自动生成api接口文档工具,支持RESTful风格,今天我们来学一下api-doc的生成预览在线预览地址开发原理这个工具是一个典型的前后端分离开发的项目,想了解前后端分离 ...
使用swagger实现在线api文档自动生成在线测试api接口
使用vs nuget包管理工具搜索Swashbuckle 然后安装便可注释依赖于vs生成的xml注释文件转载于:https://www.cnblogs.com/ProDoctor/p/752607 ...
python docx 合并文档图片_MBT文档模型化生成工具——30倍效率文档撰写工程化方法...
MBT(A model based document builder)文档模型化生成工具用户手册--30倍效率文档撰写工程化方法 1 简介在软件工程领域,工程文档通常主要包括实施方案.需求分析.软件 ...
Word 2010文档自动生成目录和某页插入页码
一.Word 2010文档自动生成目录关于Word文档自动生成目录一直是我身边同学们最为难的地方,尤其是毕业论文,经常因为目录问题,被要求修改,而且每次修改完正文后,目录的内容和页码可能都会发生变化 ...
Java支持latex,基于Java和LaTeX的文档自动生成技术研究
基于Java和 LaTeX 的文档自动生成技术研究 ◆尚宝欣徐屹 (东北电力大学理学院,吉林长春 132012) [摘要]讨论了结合Java与LaTex 自动生成 PDF文档的方法.针展名 ...
Java实现生成数据库表结构文档（生成工具screw的使用）
目录一.screw介绍 1.简介 2.特点 3.文档格式二.生成方式 2.1 方式1:使用 Java 代码 2.1.1 引入依赖 2.1.2 编写代码 2.1.3 测试 2.2 方式2:使用 Sp ...
开发工具合集专题《管理工具，DoxygenAPI文档自动生成》
Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C.C++.Java.Objective-C和IDL语言,部分支持PHP.C#.注释的语法与Qt-Doc.KDoc和J ...
干掉 Postman？测试接口直接生成API文档，这工具真香！
前几天粉丝群有小伙伴问,有啥好用的API文档工具推荐,无意间发现了一款工具,这里马不停蹄的来给大家分享一下. ShowDoc一个非常适合团队的在线API文档工具,也支持用docker自建文档服务,不过 ...

JavaScript的API文档自动生成工具jsdoc

一、概述:jsdoc是JavaScript的API文档自动生成工具

二、非项目中使用:

JavaScript的API文档自动生成工具jsdoc相关推荐

最新文章

热门文章