You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: 1-js/03-code-quality/03-comments/article.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -125,25 +125,25 @@ Describe the architecture
125
125
Document function parameters and usage
126
126
: There's a special syntax [JSDoc](http://en.wikipedia.org/wiki/JSDoc) to document a function: usage, parameters, returned value.
127
127
128
-
For instance:
129
-
```js
130
-
/**
131
-
* Returns x raised to the n-th power.
132
-
*
133
-
* @param {number} x The number to raise.
134
-
* @param {number} n The power, must be a natural number.
135
-
* @return {number} x raised to the n-th power.
136
-
*/
137
-
function pow(x, n) {
138
-
...
139
-
}
140
-
```
128
+
For instance:
129
+
```js
130
+
/**
131
+
* Returns x raised to the n-th power.
132
+
*
133
+
* @param{number}x The number to raise.
134
+
* @param{number}n The power, must be a natural number.
135
+
* @return{number} x raised to the n-th power.
136
+
*/
137
+
functionpow(x, n) {
138
+
...
139
+
}
140
+
```
141
141
142
-
Such comments allow us to understand the purpose of the function and use it the right way without looking in its code.
142
+
Such comments allow us to understand the purpose of the function and use it the right way without looking in its code.
143
143
144
-
By the way, many editors like [WebStorm](https://www.jetbrains.com/webstorm/) can understand them as well and use them to provide autocomplete and some automatic code-checking.
144
+
By the way, many editors like [WebStorm](https://www.jetbrains.com/webstorm/) can understand them as well and use them to provide autocomplete and some automatic code-checking.
145
145
146
-
Also, there are tools like [JSDoc 3](https://github.com/jsdoc3/jsdoc) that can generate HTML-documentation from the comments. You can read more information about JSDoc at <http://usejsdoc.org/>.
146
+
Also, there are tools like [JSDoc 3](https://github.com/jsdoc3/jsdoc) that can generate HTML-documentation from the comments. You can read more information about JSDoc at <http://usejsdoc.org/>.
147
147
148
148
Why is the task solved this way?
149
149
: What's written is important. But what's *not* written may be even more important to understand what's going on. Why is the task solved exactly this way? The code gives no answer.
0 commit comments