js代码注释生成文档工具-jsdoc

最新推荐文章于 2024-08-13 08:01:54 发布
最新推荐文章于 2024-08-13 08:01:54 发布
阅读量790 收藏
点赞数
文章标签： javascript html java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/yao940622/article/details/120743125
版权

需求

将js和ts的代码注释生成api文档

思路

先将ts转成js，再统一处理js文件，用jsdoc工具来生成html文件。

JsDoc

是js文档生成工具，它从javascript程序源代码中抽取类、方法、成员等注释信息形成一个和源代码配套的API帮助文档。Java开源项目，它是一个功能强大的javascript文档生成工具。https://www.shouce.ren/api/view/a/13232

使用实例

通过jsdoc将js文件转成html文件
./node_modules/jsdoc/jsdoc.js -c .jsdoc

-c 或 --configure：指定JSDoc配置文件的路径。默认为安装JSDoc目录下的conf.json或conf.json.EXAMPLE

lily-0622
关注
JS API文档生成工具jsdoc加强版
04-14
随着Javascript脚本的日益强大，对js的api生成工具的需求也是与日俱增，经过本人下载使用过的多个js api文档生成工具的比较，并对其中一款(jsdoc)进行了部分改进，感觉对于日常的基于js代码的api文档的生成大有帮助。特将其发布，以供大家使用！！ 友情提示：请下载解压后先看"先读我.txt"文档！
vim-jsdoc：将JSDoc生成为您JavaScript代码
02-02
JSDoc是一种规范，用于在JavaScript源代码中添加注释，这些注释可以自动生成文档，帮助开发者理解和维护代码。通过`vim-jsdoc`，在Vim编辑器中编写JSDoc变得更加高效和便捷。 ### JSDoc简介 JSDoc是一种文档生成...
JS文档生成工具JSDoc
yanyongshan的专栏
09-09 1595
开发文档撰写的重要性是显而易见的，特别是针对团队的协作开发，不仅能提高团队开发效率，还可以方便他人接手项目。在自动化的今天，我们不需要手工去撰写文档，只需要编写代码的同时按照一定的规则进行注释，就可以通过工具自动生成一份详细的文档，这是很惬意的事，不是么？我还有一个更好的基于Editplus工具的前端自动化的想法，也正在项目中实施，如果精力允许，我会慢慢的写出来，分享给需要的人。JS的
JSDuck：强大的JavaScript文档生成器
最新发布
gitblog_00184的博客
08-13 253
JSDuck：强大的JavaScript文档生成器 jsduckSimple JavaScript Duckumentation generator.项目地址:https://gitcode.com/gh_mirrors/js/jsduck 项目介绍 JSDuck是一款专为Sencha JavaScript框架设计的API文档生成器。尽管项目维护已经停止，但它曾经是Sencha公司用于生成Ext...
利用JSDOC快速生成注释文档，非常棒。
u011927449的博客
08-07 1146
　　有时往往我们需要建一个文档来记录js中的一些代码注释，比如一些公共的函数，又或者一些类，在团队合作中，文档接口也是必不可少的，传统的方式多少有些不便，这里介绍一个工具，它叫JSDOC，它可以用来将注释生成文档。 　　虽然说是说它可以把注释生成文档，但是也不是什么注释都可以的，我们需要按照它的规范来写。 　　首先我们通过npm来下载它。 　　npm install jsdoc -g 　　 　　JSDOC的格式是这样的。 　　 /** * 两个数相加* @param {number} num1 加.
利用JsDoc生成注释文档
dreamjay1997的博客
08-23 1546
1.下载JsDoc 打开cmd 输入下面指令就行 npm i jsdoc -g 2.使用JsDoc,在cmd中输入下面的指令，会在sever.js所在目录下面生成out文件夹,里面有sever.html文档 jsdoc sever.js  ...
JavaScript文档注释JSDoc注释
weixin_39583421的博客
09-14 4766
普通多行注释 /** * 普通的多行注释 */ 使用JsDoc JSDoc 是一个根据 JavaScript 文件中注释信息，生成 JavaScript 应用程序或模块的API文档的工具。你可以使用 JSDoc 标记如：命名空间，类，方法，方法参数等。从而使开发者能够轻易地阅读代码，掌握代码定义的类和其属性和方法，从而降低维护成本，和提高开发效率。 它必须以/ **开始，以便由JSDoc解析器识别。其他任何以 /* ， /*** 或者超过3个星号的注释，都将被JSDoc解析器忽略。 @p
jsdoc-to-markdown：从jsdoc注释的javascript生成markdown文档
02-03
从注释的源代码生成markdown API文档。 对于将API文档注入项目自述文件很有用。 概要 1.使用有效的jsdoc注释记录代码。 /** * A quite wonderful function. * @param { object } - Privacy gown * @param { ...
代码注释生成文档工具
12-05
代码注释生成文档工具是一种非常实用的开发辅助软件，它能够自动从源代码中的注释提取信息，并将这些信息组织成结构化的文档，极大地方便了开发者在项目维护过程中的文档编写工作。这类工具通常支持多种编程语言，如...
grunt-jsdoc:一个grunt插件，通过在grunt项目上运行jsdoc3来生成javascript doc
04-06
这个插件使您能够将基于注释的文档生成集成到您的Grunt构建中。 生成您的文档 安装 这个插件要求Grunt >=0.4.0 如果您以前从未使用过 ，请务必查看《指南》，因为它说明了如何创建以及安装和使用Grunt插件。 熟悉...
openapi-jsdoc:从JSDoc注释生成OpenAPI 3.0规范
04-30
openapi-jsdoc从您的JSDoc代码注释中解析您的OpenAPI（以前称为Swagger）文档。 受启发。 支持的版本 入门 安装运行 $ npm install openapi-jsdoc 您需要在definition属性中定义初始OpenAPI根对象。 有关更多详细...
javascript API 文档生成工具 [本本作品]
03-14
NULL 博文链接：https://jsrookie.iteye.com/blog/294761
jsdoc-tsd:JSDoc模板，用于基于JSDoc注释生成TypeScript定义文件
05-24
jsdoc-tsd 安装 您可以从npm安装此模块： $> npm install @otris/jsdoc-tsd 用法 要使用此模块，只需将这个项目指定为jsdoc输出的模板。 要从命令行使用此模板，请运行 $> jsdoc -t node_modules/@otris/jsdoc-tsd -r . 您还可以将此模板添加到JSON配置文件中： { "opts": { "template": "./node_modules/@otris/jsdoc-tsd" } } 输出目录/文件 要确定输出目录和/或输出文件名，可以按以下方式将路径或文件名传递给cmd调用： $> jsdoc -d <target>/<filename>.d.ts 重要提示：如果要更改结果文件的文件名，则路径必须以d.ts结尾的文件结尾 选项 ignoreScope
利用JS注释自动生成api文档神器 — jsdoc
xiaozr1223的博客
08-19 1496
利用JS注释自动生成api文档神器 — jsdoc安装运行注释文档格式 安装 1、第一种方法：全局安装jsdoc： npm install -g jsdoc 2、第二种方法：cd到项目路径下，在项目中局部安装 jsdoc： npm install --save-dev jsdoc 参考 ：https://github.com/jsdoc/jsdoc 运行 1、全局安装jsdoc时运行： jsdoc 你的js文件.js 2、局部安装 jsdoc时运行： ./node_modules/.bin/
使用jsDoc(注释规范)
smouns_的博客
08-17 2936
使用@typedef和@property 定义一个类型，然后在其他地方使用/*** @property {string} title 书名* @property {string} author 作者*//***/
如何自制 JS 注释文档生成工具
weixin_34391854的博客
07-07 425
对于一个成熟的项目而言，一定需要一个注释文档生成工具，我们有很多可选的开源项目，如jsdoc、yuidocjs 等等，拥有这些强大的工具我们完全可以胜任任何注释方面的管理了么？ 一个成熟的开发者都会知道不管怎么样的项目都会在不同的开发条件下有一些特定条件的需求，所以我今天要讲的就是如何自制自己的注释文档生成工具。 以 jsdoc-zero...
【JavaScript】文档注释详解
少莫千华
06-30 8758
在JavaScript中，文档注释是一种特殊的注释格式，用于描述代码的功能、使用方法、参数、返回值等信息。文档注释通常使用特定的注释标记和结构来表示，并且可以通过工具解析生成文档。在JavaScript中，常用的文档注释格式是使用 /** 和 */ 括起来的多行注释。/*** 这是一个示例函数，用于加法运算。* @param {number} a - 第一个操作数* @param {number} b - 第二个操作数* @returns {number} - 两个操作数的和。
小结下javascript生成注释的工具
jackyrongvip的专栏
03-10 538
一般来说,javascript的注释生成工具比较少,比较麻烦,小结了一些以备用: JS的文档生成工具常见的有以下几种： 1）JSDoc，是perl编写的，运行稳定，模板修改也挺方便，经过简单汉化和模板风格修改之后，是首选。 2）JSDoc-toolkits，Java编写的，据说是Google推荐的JS文档生成工具，经过测试，可以生成文档，但问题多多，或许是我研究的不够，在查了多处资...
JS-ES6 jsdoc通过注解生成->更具规格的API文档
北京-老黑的博客
06-25 2191
前言： 在敏捷开发的过程中或者说是项目后期维护的过程中，文档是必不可少的，可以避免过多的交流从而加快项目的速度，今天介绍的就是一款基于前端的工具jsdoc,他能够根据代码中的注释很快生成API文档,只需要一个命令。 1.首先我这里推荐一个注释的快捷键工具，您可以在VS Code 中安装它。 插件名称：koroFileHeader 截图： 这个插件安装...
Eclipse中JavaDoc与JsDoc生成指南：工具与实战教程
本文档主要介绍了如何在Java和JavaScript开发环境中使用两种不同的...总结来说，本文档为开发者提供了一套完整的指南，帮助他们在处理Java和JavaScript代码时，通过JavaDoc和JsDoc生成文档，提高代码理解和协作效率。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值