JavaScript学习记录——JsDoc学习

最新推荐文章于 2024-05-13 14:25:39 发布
最新推荐文章于 2024-05-13 14:25:39 发布
阅读量949 收藏
点赞数
分类专栏： JavaScript学习过程记录 文章标签： javascript jsDoc
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/stevensz7/article/details/23123145
版权
本文介绍如何使用JSDoc生成文档，并结合Docstrap定制样式。通过具体命令展示整个流程，包括配置文件及模板的选择。

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

JavaScript 学习总结（18）—— JavaScript 代码规范与常见技巧总结
科技D人生
01-20 132
高阶函数（Higher-OrderFunction），简单来说，就是满足以下一个或两个条件的函数：1.接受一个或多个函数作为参数：在JavaScript中，函数是一等公民，这意味着函数可以像其他数据类型（如数字、字符串）一样被传递和操作。例如，我们可以将一个函数作为参数传递给另一个函数，让接收函数根据不同的逻辑来调用传入的函数。2.返回一个函数：高阶函数执行完毕后，返回的结果也是一个函数。这使得我们能够根据不同的条件动态生成可执行的函数。
docstrap, 在 Bootstrap 上，以Bootswatch为主题，一个基于JSDoc3的模板.zip
09-18
docstrap, 在 Bootstrap 上，以Bootswatch为主题，一个基于JSDoc3的模板 DocStrap DocStrap是基于 Bootstrap的 JSDoc3模板模板。 除了的所有主题，它还提供了大量的主题，为你的文档提供了大量的外观和感觉选项，同时还提供了简单的搜索。 此外，它向 conf.j
jsdoc 学习笔记
海胆的博客
02-12 243
定义类型 （ts 中 type 的思路相同）需要配置 jsdoc.json。如果是对象的话可以定义属性。来设置跳转但类型、对象；
【jsDoc】jsDoc学习记录
等时钟成长
03-22 302
jsDoc学习记录 一、安装 npm install -g jsdoc # 全局安装 二、书写规范 @abstract 抽象方法 @virtual @access 访问权限 private protected package public /** constructor */ function Thingy() { /** @access private */ var foo...
2017.7.11 学习记录 JavaScript 方法使用及时间代码
xiaomaijiecao的博客
07-12 249
JavaScript 方法使用及时间代码
课件记录
u013240484的专栏
12-28 572
Oberon-0中 最基本的语句是赋值语句；复合语句支持顺序、条件（if语句）和迭代（while语句）执行。 参数传递方式：按值调用（值参数）和按引用调用（可变参数） 仅有的基本数据类型是整数类型（INTEGER）和布尔类型（BOOLEAN） 词法定义 大小写无关，标识符长度不超过24个字符 (* .. *)之间全部为注释 常量可以由0开头，此时解释为八进制常量
前端开源库-jsdoc-oblivion
08-30
`jsdoc-oblivion`是专门为JSDoc设计的一个主题，它的特色在于提供了两种颜色风格——灰色和蓝色。这两种主题不仅使得生成的文档在视觉上更吸引人，而且也保持了良好的可读性，有助于开发者快速找到所需的信息。主题...
Javascript新手入门实践：note-book-js项目挑战指南
- 使用`sudo npm install -g jsdoc local-web-server`命令：这个命令用于全局安装两个npm包——`jsdoc`和`local-web-server`。`jsdoc`是一个工具，用于从代码注释中自动生成文档。这对于编写清晰、规范的代码注释...
掌握JavaScript代码库的高效管理之道
npm是JavaScript的包管理工具，它允许开发者安装第三方模块，并将依赖信息记录在`package.json`文件中。随着项目的增长，依赖项数量也会增加，良好的依赖管理可以避免潜在的冲突，并且有助于项目的可持续发展。 5. ...
javascript方法
最新发布
03-25
* @return {Promise<Array<Object>>} 包含每行记录的对象数组 */ async function parseCsv(filePath) { const data = await fs.promises.readFile(path.resolve(__dirname, filePath), 'utf8'); const rows = ...
JSDoc 实践
weixin_34168700的博客
12-14 285
背书 JSDoc是一个根据javascript文件中注释信息，生成JavaScript应用程序或库、模块的API文档 的工具。你可以使用他记录如：命名空间，类，方法，方法参数等。类似JavaDoc和PHPDoc。现在很多编辑器或IDE中还可以通过JSDoc直接或使用插件生成智能提示。从而使开发者很容易了解整个类和其中的属性和方法，并且快速知道如何使用，从而提高开发效率，降低维护成本。 JSDoc...
搭建jsdoc+ink-docstrap开发文档详细过程
pleasantsheep_的博客
05-13 529
在调试中添加docs：jsdoc -c jsdoc.json，如果你的jsdoc.json文件不在package.json同一级，需要改成 jsdoc -c 你的 jsdoc.json地址。[图片](../src/assets/logo.png)，[ ]表示图片加载不出来时的占位符。创建一个js文件(我这里只是做一个示范，你若想直接链接到你的js文件可以不用这一步)。)，也可以链接本地文件，不过要注意文件路径要从docs文件夹往外读。1，一级标题：#，二级标题：##4，代码块：``` 代码```
jsDoc开发文档生成
pleasantsheep_的博客
05-13 1394
一键生成 jsdoc 开发文档
为JSDoc3的index.html增加说明文档
wts的专栏
02-14 2350
之前简单介绍了如何用JSDoc3以及JSDoc3+Docstrap生成jsdoc。 但生成的文档首页Index.html都是一片空白，我们可能需要在这里增加一些说明性的文字。 JSDoc的自定义能力确实很强，我们增加一个readme.md这样的markdown格式的文件就可以了。 比如我的js文件位于：d:\myjs\，要生成的jsdoc放在d:\mydoc。 我们首先可以在任意位置创建一
JSDoc3的简单使用
wts的专栏
02-12 4846
官方网站：https://github.com/jsdoc3/jsdoc/ 建议不要直接通过“Download ZIP”功能直接下载，而是到Release中下载稳定版本，比如3.2.2 下载后，直接解压到某个目录，比如d:\jsdoc 然后设置windows环境变量，在path中增加d:\jsdoc，这样我们在那个目录下，都可以执行jsdoc命令了。 假设要对d:\js\myjs.js生成
jsdoc快速入门
阿祥_优快云
10-04 1216
在编码的过程中，很多情况下我们都有输出 api 文档的需求，因此本文将介绍如何使用 jsdoc 输出 api 文档。
JSDoc3+Docstrap的使用
wts的专栏
02-14 5386
JSDoc3默认提供了两个模板，默认的模板生成的doc还是比较难看的，另外一个haruki只提供命令行状态下的json输出，不是我们要的。 网络上搜了一下，找到Docstrap，提供多种模板效果，还不错。 1、JSDoc3 JSDoc3这里不说了，下载和配置，见《JSDoc3的简单使用》。 2、Docstrap 官方开源地址：https://github.com/terryweiss/d
TWaver HTML5学习笔记 —— 动态设置网元样式
Steven的专栏
03-23 4640
一、学习内容概述：      学习如何在拓扑图中动态设置网元的样式。 二、学习内容总结： 1、添加属性表格：       1）、属性表格定义：使用twaver.controls.PropertySheet类，例如： var nodeStylePropertySheet = new twaver.controls.Property
利用Gulp实现JSDoc 3的文档编写过程中的实时解析和效果预览
weixin_30344795的博客
08-28 147
###利用Gulp实现JSDoc 3的文档编写过程中的实时解析和效果预览http://segmentfault.com/a/1190000002583569 转载于:https://www.cnblogs.com/yingwo/p/4766601.html
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值