@@ -62,7 +62,7 @@ On the second line:
62
62
63
63
* `@param ` is **a tag**: This tag indicates that we'll be documenting a function's parameter.
64
64
* `{number}` is **a type**. It says that the input to this function is
65
- a JavaScript "number". It could also say `{string}`,
65
+ a JavaScript "number." It could also say `{string}`,
66
66
`{Object}`, `{Date}`, or any other JavaScript built-in type. And if you
67
67
defined a custom class, like `FooClass`, you can use it as a type, too! Just say `{FooClass}`.
68
68
* `input` is the name of the input variable. It matches what the code
@@ -96,7 +96,7 @@ populates `@name`, `@kind`, and `@memberof` tags based on its reading of the
96
96
code.
97
97
98
98
**Normalization**: JSDoc has multiple words for the same thing: you can
99
- say `@augments ` or `@extends ` and they'll do the same thing.
99
+ say `@augments ` or `@extends `, and they'll do the same thing.
100
100
101
101
## Development Process
102
102
@@ -108,17 +108,16 @@ automated style check.
108
108
## The Tags
109
109
110
110
[**`jsdoc.app`**](https://jsdoc.app/) covers all available tags in the
111
- JSDoc syntax, and is a great reference.
112
-
113
- The most commonly used tags are:
114
-
115
- * `@param ` - input given to a function as an argument
116
- * `@returns ` - output value of a function
117
- * `@name ` - explicitly set the documented name of a function, class, or variable
118
- * `@private ` - you can use `@private ` to document
119
- code and not have it included in the generated documentation;
120
- maybe it's not part of the public API. There's also `@public ` and `@protected `
121
- * `@example ` - you can use the `@example ` tag to add inline code examples with your
111
+ JSDoc syntax, and is a great reference. The most commonly used tags
112
+ are:
113
+
114
+ * @param - input is given to a function as an argument
115
+ * @returns - output value of a function
116
+ * @name - explicitly set the documented name of a function, class, or variable
117
+ * @private - you can use @private to document
118
+ code and not have it included in the generated documentation,
119
+ maybe it's not part of the public API. There's also @public and @protected
120
+ * @example - you can use the @example tag to add inline code examples with your
122
121
documentation
123
122
124
123
If your text editor does not highlight JSDoc tags,
0 commit comments