jsdoc的简单使用

梦里梦外; 2022-12-31 12:21 171阅读 0赞

### 安装 ###

npm install jsdoc -g

### 书写 ###

jsdoc有一套自己的规范，要按规矩办事，比如下：

/** * 求两个数的积 * @param {number} x - 乘数 * @param {number} y - 被乘数 * @return {number} 积 */
    function multiply(x, y) { 
      return x * y;
    }

这里有个小技巧，一般ide都会支持自动补全注释，也就是最好先写好你的方法，之后再去写jsdoc的注释。比如上边的方法，再方法写好之后，再输入

`/**` 并按回车，就会得到以下的效果：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzQ1OTg2Ng_size_16_color_FFFFFF_t_70]  
以上是vscode的注释补全。

最后运行，jsdoc会生成静态页面，拖到浏览器就可以预览了  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzQ1OTg2Ng_size_16_color_FFFFFF_t_70 1]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzQ1OTg2Ng_size_16_color_FFFFFF_t_70 2]  
样式还是很不错的

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzQ1OTg2Ng_size_16_color_FFFFFF_t_70]: /images/20221120/80145be86bfd44fd926101104ef6c31c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzQ1OTg2Ng_size_16_color_FFFFFF_t_70 1]: /images/20221120/af7f495033c84ebcac75497082334b8b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzQ1OTg2Ng_size_16_color_FFFFFF_t_70 2]: /images/20221120/9b2e06373ae84f929090b24ed79b7565.png

发表评论取消回复

表情：

评论列表（有 0 条评论，171人围观）

还没有评论，来说两句吧...

相关阅读

相关精通 JSDoc：Javascript 开发人员的完整指南

介绍作为 Javascript 开发人员，我们都明白编写干净、可读和可维护代码的重要性。我们实现这一目标的方法之一是正确记录我们的代码。这就是JSDoc 发挥作用的地方。

港控/mmm°/ 2023年09月26日 22:28/ 0 赞/ 101 阅读

相关 jsdoc的简单使用

安装 npm install jsdoc -g 书写 jsdoc有一套自己的规范，要按规矩办事，比如下： / 求两个数的积 @param {

梦里梦外;/ 2022年12月31日 12:21/ 0 赞/ 172 阅读

相关前端-jsdoc-快速搭建

由于我们使用了ES6高级语法，发现钟爱的 jsduck 不能用了。只能选择 jsdoc。环境：node14 第1步：运行 npm i jsdoc -g 第2步：

不念不忘少年蓝@/ 2022年11月15日 11:55/ 0 赞/ 137 阅读

相关 Hbuilder X 与JSDoc 3

一、前言在一个模块里写方法的时候，突然想到，Hbuilder X 在写某些方法时会给出一定的提交，如下： ![d38060baae91bc800c297fc49c3

柔光的暖阳◎/ 2022年11月15日 03:56/ 0 赞/ 175 阅读

相关 python的简单使用_python简单的使用(二)

1． Python中的错误检测前面已经知道了input()和raw\_input()的用法了，input()会在接收了“字符串”的输入之后进行一些处理，比如你是输入1+2，

红太狼/ 2022年10月28日 00:52/ 0 赞/ 205 阅读

相关 EasyUI的简单使用

WebRoot┐ ├js┐ ├easyUI┐ ├themes┐

矫情吗；*/ 2022年08月07日 13:46/ 0 赞/ 255 阅读

相关使用JSDoc提高代码的可读性

> 工作了四年多，基本上都在围绕着 JavaScript 做事情。 > 写的代码多了，看的代码也多了，由衷的觉得，写出别人看不懂的代码并不是什么能力，写出所有人都能读懂的代

古城微笑少年丶/ 2022年05月01日 12:18/ 0 赞/ 258 阅读

相关 Matplotlib的简单使用

![20190421194205135.png][] Matplotlib是一个Python 2D绘图库,只需几行代码即可生成绘图，直方图，功率谱，条形图，错误图，散点图等

港控/mmm°/ 2022年02月16日 04:51/ 0 赞/ 266 阅读

相关 pyenv 的简单使用

系统:Ubuntu16.04 pyenv virtualenv 2.7.1 env271 创建新的环境,位于 ~/.pyenv/versions/

你的名字/ 2021年11月16日 08:12/ 0 赞/ 425 阅读

相关 typescript JSDoc对js文件进行类型检查

(1)修改tsconfig.js "checkJs": true, 对js文件进行类型检查你可以通过添加// @ts-nocheck注释来

迷南。/ 2021年07月24日 19:34/ 0 赞/ 418 阅读