jsdoc-toolkit 简明用法

最新推荐文章于 2025-08-23 19:36:46 发布
最新推荐文章于 2025-08-23 19:36:46 发布
阅读量53 收藏
点赞数
CC 4.0 BY-SA版权
文章标签： java
原文链接：http://www.cnblogs.com/chinaontology/archive/2008/10/12/1309015.html
本文介绍 JSDoc Toolkit 的使用步骤：确保 Java 运行环境已安装；从官方网站下载并解压缩工具包；通过命令行调用 jsrun.jar 文件，指定模板及源代码文件，最后在安装目录下的 out 子目录中查看生成的文档。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

jsdoc-toolkit 用法：

首先必须有 Java 程序的运行环境。然后：

1. 下载 http://code.google.com/p/jsdoc-toolkit/downloads/list

2. 解压到一个目录下

3. Windows 下进入命令行模式，进入其目录

4. 执行 java -jar jsrun.jar app\run.js -a -t=templates\jsdoc mycode.js

其中的 mycode.js  是你的代码，运行此命令后将在安装目录下生成 out 子目录， 你的文档已经在里面了， Enjoy！

转载于:https://www.cnblogs.com/chinaontology/archive/2008/10/12/1309015.html

js doc工具推荐及使用（一）：jsdoc-toolkit
wjxbj的博客
01-22 377
        在项目开发过程中，需要合适的工具来生成doc文件，通过google以及试用，发现jsdoc-toolkit和ext-doc2个工具比较有意思。         下面详细介绍下jsdoc-toolkit在实际工程中的应用         官方地址为：http://code.google.com/p/jsdoc-toolkit/         相关注释标签为：http://...
jsdoc-toolkit文档工具使用说明
厚积薄发
03-15 2474
JsDoc Toolkit 是一款辅助工具，你只需要根据约定在 JavaScript 代码中添加相应的注释，它就可以根据这些注释来自动生成API文档。对Java 熟悉的人可能会发现它和 Java 的文档自动化工具 JavaDoc 很像，没错，JsDoc Toolkit 就是基于 JavaDoc 开发的。 项目地址：http://code.google.com/p/jsdoc-toolkit/。
小白都会使用的jsDoc-vue
yy6818的博客
05-18 1732
小白都会使用的jsDoc-vue 第一步 安装依赖 这里有三个依赖 minami jsdoc vue-template-complier 安装依赖 npm install --save-dev jsdoc npm install --save-dev minami npm install --save-dev vue-template-complier 使用yarm的话把 npm install 换成 yarn add 第二步 配置 在前端vue项目根目录创建 .jsdoc.config.j
jsdoc-toolkit生成javascriptAPI文档
zeromike
01-22 144
            前言          对于使用JAVA的人来说，查看JavaDoc文档开发非常方便。当我们开发WEB应用的时候，需要javascriptAPI文档开发。在此，我选择了jsDoc-toolkit生成相关文档。          环境：win7,jdk1.7          我在这里就不讲解jdk的安装和配置了，这样的文章太多了。         简介   ...
Jsdoc-to-markdown
小花生编程
10-16 1258
需求 JSDOC生成的文档（html）和现在开发者网站要求的文档格式（markdown）不一致，导致API文档展示不够理想。 调研结果 JSDOC直接生成MD：https://github.com/jsdoc2md/jsdoc-to-markdown，使用demo文件可以直接生成，也可支持ts。 优化方案 1．通过工具jsdoc-to-markdown将js内容生成为md格式文件，与内容文档一致 2．读取不成功的类，跳过，并将错误原因写入log； 3．生成文档索引json文件，便于入库和索引 运用实例 命令
使用jsdoc-toolkit来自动生成js api文档
chunshen9950的博客
10-27 228
一、环境搭建 1)首先要安装java环境，如果不太了解的参看：http://jingyan.baidu.com/article/e75aca85b29c3b142edac6a8.html 2)安装jsdoc-toolkit 下载地址：http://code.google.com/...
JSDoc-VueJS 开源项目教程
gitblog_00689的博客
08-23 358
JSDoc-VueJS 开源项目教程 项目介绍 JSDoc-VueJS 是一个开源项目，旨在为 Vue.js 组件生成文档。通过结合 JSDoc 和 Vue.js，开发者可以为他们的 Vue 组件编写详细的文档，从而提高代码的可维护性和可读性。该项目支持 Vue 2 和 Vue 3，并且易于集成到现有的 Vue 项目中。 项目快速启动 安装 首先，你需要在你的项目中安装 JSDoc 和 JSDoc...
标题：VueJS的文档利器——JSDoc-VueJS
gitblog_00078的博客
05-29 486
标题：VueJS的文档利器——JSDoc-VueJS 1、项目介绍 JSDoc-VueJS 是一款为VueJS开发者精心设计的JSDoc插件。它允许您方便地在.vue文件中添加注释，以便自动生成详细的组件属性（props）、数据（data）、计算属性（computed）和方法等文档，使得代码更易读、可维护性更强。 2、项目技术分析 JSDoc-VueJS依赖于Node.js环境，并要求Vue版本为...
使用jsdoc-toolkit实现JS API文档自动化
aocucuan5035的博客
11-11 119
在前面的博文中探讨自动化工程问题时，写过基于NodeJS的，使用gulp、grunt的jsdoc插件实现文档自动化。本文探讨基于java环境的自动化实现。 一、Java安装与环境配置 关于Java的安装与环境配置，可以参考博文YUI Compressor for Sublime text2 二、jsdoc-tookit下载与使用 下载链接：jsdoc-tookit，现在地址可能被...
学习Java24天
最新发布
2401_88987098的博客
08-23 56
（调对象的read）相当于数据输入流（DateIntputstream）写什么打什么（如果要追加需要包低级管道，看第一行）161/199（这几天加把劲把JavaSE学完）（需要读时按照对应顺序的数据类型读数据）IO流（缓冲流和特殊流及io框架）（缓冲字节输入流（包装））（包含缓冲字节输出流）
深入理解 Spring 的 @ControllerAdvice
Roc的博客
08-20 849
简单来说，是一个组件注解（被@Component元注解标注），它允许你将一个类声明为一个全局的、跨多个控制器的增强器（Advice）。你可以把它理解为 Spring MVC 版本的AOP（面向切面编程），但它不是基于代理，而是专门为控制器层设计的。全局异常处理全局数据绑定全局数据预处理命名清晰：类名如，明确其职责。区分使用场景开发，优先使用，专注于返回统一的 JSON 异常响应。开发传统多页应用，使用，可以混合处理异常、绑定模型等。避免过度使用。
java基础知识总结
yvya_的博客
08-19 1708
java 基础包含语法、面向对象，异常处理、文件操作等方面。
Docker容器化部署实战：Tomcat与Nginx服务配置指南
Java
08-22 169
通过Docker快速部署Tomcat和Nginx服务，使用临时容器提取默认配置并挂载到宿主机实现持久化。
Java虚拟机故障处理工具全指南
qq_73993301的博客
08-20 1194
JVM故障处理工具全景指南：从基础到高阶诊断 本文系统介绍了JVM提供的故障诊断工具链，包括命令行工具（jps、jstat、jinfo、jmap、jhat、jstack、jcmd）和可视化工具（jconsole、VisualVM）。详细解析了各工具的核心功能和使用场景：jps用于进程查看、jstat监控GC行为、jmap生成堆转储等。文章提供了实战建议，强调基线数据收集和工具组合使用的重要性，并指出生产环境的使用注意事项。最后还介绍了远程连接、自动化分析等高级技巧，推荐结合Arthas、MAT等专业工具进行
健康常识查询系统|基于java和小程序的健康常识查询系统设计与实现(源码+数据库+文档)
伟庭的博客
08-21 684
本文介绍了一款基于Java和微信小程序的健康常识查询系统设计与实现。系统采用B/S架构，使用MySQL数据库，包含用户端和管理端两大模块。用户可通过小程序查看健康资讯、进行论坛交流、在线咨询及管理健康档案；管理员通过Web端实现用户管理、公告发布等功能。系统设计包含详细的功能结构图、界面展示和ER图，并提供了核心代码示例。该系统旨在为用户提供便捷的健康管理工具，满足现代人对健康信息查询和管理的需求。
java-代码随想录第十四天| 二叉树层序遍历相关题目
qq_57465625的博客
08-20 979
本文介绍了二叉树的基本概念和常见算法题解。基本概念部分阐明了深度（从根节点到该节点的路径长度）和高度（从该节点到最远叶子节点的路径长度）的定义与计算方法。算法题解包括：1）226.翻转二叉树的递归解法；2）101.对称二叉树的递归判断方法；3）104.二叉树最大深度的递归计算；4）111.二叉树最小深度的递归解法，特别处理了单子树为空的情况。所有解法均采用分治思想，通过递归实现，并附有详细注释说明。
java-ArrayList的使用
m0_52132903的博客
08-21 289
JavaScript 性能优化实战大纲
luomoyoushang的博客
08-19 321
【代码】JavaScript 性能优化实战大纲。
50.Seata-AT模式
卷土的博客
08-20 297
AT模式同样是分阶段提交的事务模型。优势是。没有代码入侵，框架自动完成快照生成、回滚和提交。实现非常简单。两阶段之间属于软状态，属于最终一致。
使用jsdoc-toolkit提升JavaScript API文档生成效率
标题“jsdoc-toolkit生成javascriptAPI文档”指向了使用jsdoc-toolkit工具来创建JavaScript API文档的主题。jsdoc-toolkit是一个文档生成工具，它能够扫描JavaScript代码，根据代码中的注释生成格式化的API文档。...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值