Skip to content

Commit 2e41f52

Browse files
committed
add : add javascript @param docs
1 parent 2e4813e commit 2e41f52

File tree

5 files changed

+10
-7
lines changed

5 files changed

+10
-7
lines changed

javascript/param/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -82,4 +82,10 @@
8282

8383
## 标签效果
8484

85-
![demo.jpg](./docs/demo.png)
85+
### 函数入参定义类型
86+
87+
![demo.jpg](./docs/demo1.png)
88+
89+
### 函数的入参是一个对象,可以定义入参对象属性类型
90+
91+
![demo.jpg](./docs/demo2.png)

javascript/param/demo1.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77
* @param {Array.<string>} arrayVar - 字符串数组
88
*/
99
function TagParam(stringVar, arrayVar) {
10-
// FIXME. @param定义arrayVar是字符串类型数组,所以在push一个数字类型的变量时,会产生一个告警
10+
// FIXME. @param定义arrayVar是{Array.<string>},所以在push一个{number}类型的变量时,因<类型不符>会产生一个告警
1111
arrayVar.push(123);
1212
}
1313

1414
// PASS.
1515
TagParam("123456", []);
1616

17-
// FIXME. @param定义stringVar类型是字符串,而实际入参是数字,所以会产生一个告警
17+
// FIXME. @param定义stringVar类型是{string},而实际入参是{number},因为会产生一个告警
1818
TagParam(123456, ["123456", "456789"]);
1919

javascript/param/demo2.js

+1-4
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,9 @@
77
* @param {number} people.age - 年龄
88
*/
99
function TagParam(people) {
10-
// TODO 下拉
11-
// people.
12-
1310
// PASS
1411
Math.abs(people.age);
1512

1613
// FIXME. @param定义people.name类型为string,而Math.abs要求入参是number,所以会产生一个告警
1714
Math.abs(people.name);
18-
}
15+
}

javascript/param/docs/demo1.png

79.3 KB
Loading

javascript/param/docs/demo2.png

61.8 KB
Loading

0 commit comments

Comments
 (0)