盒子
盒子
文章目录
  1. Examples
  2. Tags

使用jsdoc通过注释来自动生成js文档

如果要维护一个项目, 文档是必不可少的, 如果没有文档, 你同事看起来就会减少效率.

好处不觉得没有必要写了, 好多公司都需要一个文档来注释项目的api

这里js我们选着jsdoc来生成

安装

npm install -g jsdoc

命令行中使用
jsdoc youJavascriptFile.js

项目中安装
npm install --save-dev jsdoc

安装在项目中我们必须要调用./node_modules/.bin/jsdoc youJavascriptFile.js

一般生成好的文件在out目录下,

Examples

这里具体要说的是几个注释模板, 让你生成后的代码api文档更美观

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
/** Class representing a point. */
class Point {
/**
* Create a point.
* @param {number} x - The x value.
* @param {number} y - The y value.
*/
constructor(x, y) {
// ...
}
/**
* Get the x value.
* @return {number} The x value.
*/
getX() {
// ...
}
/**
* Get the y value.
* @return {number} The y value.
*/
getY() {
// ...
}
/**
* Convert a string containing two comma-separated numbers into a point.
* @param {string} str - The string containing two comma-separated numbers.
* @return {Point} A Point object.
*/
static fromString(str) {
// ...
}
}
/** @module color/mixer */
/** The name of the module. */
export const name = 'mixer';
/** The most recent blended color. */
export var lastColor = null;
/**
* Blend two colors together.
* @param {string} color1 - The first color, in hexadecimal format.
* @param {string} color2 - The second color, in hexadecimal format.
* @return {string} The blended color.
*/
export function blend(color1, color2) {}
// convert color to array of RGB values (0-255)
function rgbify(color) {}
export {
/**
* Get the red, green, and blue values of a color.
* @function
* @param {string} color - A color, in hexadecimal format.
* @returns {Array.<number>} An array of the red, green, and blue values,
* each ranging from 0 to 255.
*/
rgbify as toRgb
}

Tags

具体可以看官方文档, jsdoc

妈妈再也不用担心文档需要自己手写了!!!