JSDoc3的简单使用

官方网站：https://github.com/jsdoc3/jsdoc/

建议不要直接通过“Download ZIP”功能直接下载，而是到Release中下载稳定版本，比如3.2.2

下载后，直接解压到某个目录，比如d:\jsdoc

然后设置windows环境变量，在path中增加d:\jsdoc，这样我们在那个目录下，都可以执行jsdoc命令了。当然还有个前提，就是windows环境变量中已经把jdk配置好了。

假设要对d:\js\myjs.js生成jsdoc文档，则：

1、打开dos窗口

2、在dos窗口中执行命令：

jsdoc d:\js\myjs.js

回车后，会在d:\js目录下生成一个out文件夹，里面就是html形式的doc了。

如果要对js目录中所有js文件生成文档，则执行：

jsdoc d:\js

如果要对js目录中的个别文件生成文档，则执行：

jsdoc d:\js\a.js d:\js\b.js

如果要指定生成文档的目录，则可以在命令行后继续增加参数： -d d:\out

这个时候，jsdoc是使用的默认模板生成的jsdoc，效果不是很理想，我们需要找到好一点的模板。

执行jsdoc --help，回车，我们会看到该命令支持的所有参数。

jsdoc的完整官方文档：http://usejsdoc.org/

执行jsdoc --debug，回车，我们会看到一个Java窗口程序，好像是Rhino的，不懂，这个窗口跟调试有关。

JSDoc3的简单使用相关推荐

在docker上安装部署tomcat项目超简单，拿来主义
在docker中部署tomcat,非常简单,而且省去了手动安装jdk等步骤,只需要将war包复制在容器tomcat实例中的webapps下面即可.以下将详细讲解流程: 在windows中打好包以后用w ...
Linux下tomcat的安装与卸载以及配置（超简单）
无敌简单的几步 1.安装 //首先你需要下载好tomcat包 sudo tar -xvzf apache-tomcat-7.0.85.tar.gz(这里是包名) -C 你要放的位置 2.卸载 rm - ...
Docker安装Apache与运行简单的web服务——httpd helloworld
Docker运行简单的web服务--httpd helloworld目录[阅读时间:约5分钟] 一.Docker简介二.Docker的安装与配置[CentOS环境] 三.Docker运行简单的web ...
Docker的安装、镜像源更换与简单应用
Docker的安装.镜像源更换与简单应用[阅读时间:约20分钟] 一.概述二.系统环境&项目介绍 1.系统环境 2.项目的任务要求三.Docker的安装四.Docker的简单应用 1. ...
基于Golang的简单web服务程序开发——CloudGo
基于Golang的简单web服务程序开发--CloudGo[阅读时间:约10分钟] 一.概述二.系统环境&项目介绍 1.系统环境 2.项目的任务要求 (1)基本要求 (2)扩展要求三.具体 ...
简单图文配置golang+vscode【win10/centos7+golang helloworld+解决install failed等情况】
博客目录(阅读时间:10分钟) 一.win10 0.系统环境 1. win10配置golang环境 ①下载相关软件 ②创建gowork工作空间 ③配置环境变量(GOPATH+PATH) ④验证环境配置 ...
简单介绍互联网领域选择与营销方法
在我看来,互联网领域的选择是"安家",而营销方法的不同则表现了"定家"的方式多种多样,只有选对了,"家"才得以"安定". ...
JAVA用最简单的方法来构建一个高可用的服务端，提升系统可用性
一.什么是提升系统的高可用性 JAVA服务端,顾名思义就是23体验网为用户提供服务的.停工时间,就是不能向用户提供服务的时间.高可用,就是系统具有高度可用性,尽量减少停工时间.如何用最简单的方法来搭建 ...
java发送简单邮件_Java程序实现发送简单文本邮件
/** * Java程序实现发送简单文本邮件 * * @author Administrator * */ public class SendTextMail { // 定义发件人地址 public ...

JSDoc3的简单使用

JSDoc3的简单使用相关推荐

最新文章

热门文章