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
+25-67Lines changed: 25 additions & 67 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,15 +4,11 @@ După cum știm din capitolul <info:structure>, comentariile pot fi pe o singur
4
4
5
5
Noi le folosim în mod obișnuit pentru a descrie cum și de ce funcționează codul.
6
6
7
-
<<<<<<< HEAD
8
-
La prima vedere, scrierea comentariilor pare a fi evidentă, dar adeseori începătorii în programare fac greșeli.
9
-
=======
10
-
At first sight, commenting might be obvious, but novices in programming often use them wrongly.
11
-
>>>>>>> 852ee189170d9022f67ab6d387aeae76810b5923
7
+
La prima vedere, scrierea comentariilor pare a fi evidentă, dar deseori începătorii în programare fac greșeli.
12
8
13
-
## Comentarii rele
9
+
## Comentarii greșite
14
10
15
-
Începătorii tind să utilizeze comentariile pentru a explica "ce se întâmplă în cod". Ceva de genul ăsta:
11
+
Începătorii tind să utilizeze comentariile pentru a explica "ce se întâmplă în cod". Cam așa:
16
12
17
13
```js
18
14
// Acest cod va face asta (...) și asta (...)
@@ -48,6 +44,7 @@ function showPrimes(n) {
48
44
49
45
Varianta mai bună, cu o funcție separată `isPrime`
50
46
47
+
51
48
```js
52
49
functionshowPrimes(n) {
53
50
@@ -120,68 +117,33 @@ function addJuice(container) {
120
117
121
118
Deci, comentarii explicative sunt de obicei rele. Ce comentarii sunt bune?
122
119
123
-
<<<<<<< HEAD
124
120
Descrierea arhitecturii
125
-
: Oferă o vedere de ansamblu asupra componentelor, cum interacționează, care este ordinea de control în diverse situații... Pe scurt -- ochiul de vultur al codului. Există un limbaj-diagramă special [UML](https://ro.wikipedia.org/wiki/Unified_Modeling_Language) pentru diagrame de nivel înalt. Cu siguranță merită studiate.
121
+
: Oferă o vedere de ansamblu asupra componentelor, cum interacționează, care este ordinea de control flow în diverse situații... Pe scurt -- privirea de ansamblu a codului. Există un limbaj special [UML](https://ro.wikipedia.org/wiki/Unified_Modeling_Language) pentru a construi diagrame de arhitectură high-level. Cu siguranță merită studiate.
126
122
127
123
Documentarea utilizării unei funcții
128
-
: Există o sintaxă specială [JSDoc](http://en.wikipedia.org/wiki/JSDoc) pentru pentru a documenta funcțiile: utilizare, parametri, valoare returnată.
129
-
=======
130
-
Describe the architecture
131
-
: Provide a high-level overview of components, how they interact, what's the control flow in various situations... In short -- the bird's eye view of the code. There's a special language [UML](http://wikipedia.org/wiki/Unified_Modeling_Language) to build high-level architecture diagrams explaining the code. Definitely worth studying.
132
-
133
-
Document function parameters and usage
134
-
: There's a special syntax [JSDoc](http://en.wikipedia.org/wiki/JSDoc) to document a function: usage, parameters, returned value.
135
-
>>>>>>> 852ee189170d9022f67ab6d387aeae76810b5923
136
-
137
-
<<<<<<< HEAD
138
-
De exemplu:
139
-
```js
140
-
/**
141
-
* Returnează x la puterea n.
142
-
*
143
-
* @param {number} x Numărul ridicat la putere.
144
-
* @param {number} n Puterea, trebuie să fie un număr natural.
145
-
* @return {number} x ridicat la puterea n.
146
-
*/
147
-
function pow(x, n) {
148
-
...
149
-
}
150
-
```
151
-
Comentariile de acest tip ne permit să înțelegem scopul funcției și să o folosim în modul corect fără a ne uita în codul ei.
124
+
: Există o sintaxă specială [JSDoc](http://en.wikipedia.org/wiki/JSDoc) pentru pentru a documenta o funcție: utilizare, parametri, valoare returnată.
152
125
153
-
154
-
Apropo, multe editoare precum [WebStorm](https://www.jetbrains.com/webstorm/) le pot înțelege la fel de bine și să le folosească pentru a asigura autocompletare și verificări automate ale codului.
155
-
156
-
De asemenea, sunt și unelte precum [JSDoc 3](https://github.com/jsdoc3/jsdoc) care pot genera documentație HTML din comentarii. Poți citi mai multe informații despre JSDoc la <http://usejsdoc.org/>
157
-
=======
158
-
For instance:
126
+
Spre exemplu:
159
127
```js
160
128
/**
161
-
* Returns x raised to the n-th power.
162
-
*
163
-
* @param{number}xThe number to raise.
164
-
* @param{number}nThe power, must be a natural number.
165
-
* @return{number} x raised to the n-th power.
166
-
*/
129
+
* Returnează x la puterea n.
130
+
*
131
+
* @param{number}xNumărul de ridicat la putere.
132
+
* @param{number}nPuterea, trebuie să fie un număr natural.
133
+
* @return{number} x ridicat la puterea n.
134
+
*/
167
135
functionpow(x, n) {
168
-
...
136
+
...
169
137
}
170
138
```
171
139
172
-
Such comments allow us to understand the purpose of the function and use it the right way without looking in its code.
173
-
174
-
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.
175
-
176
-
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/>.
177
-
178
-
Why is the task solved this way?
179
-
: 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.
180
-
181
-
If there are many ways to solve the task, why this one? Especially when it's not the most obvious one.
182
-
>>>>>>> 29216730a877be28d0a75a459676db6e7f5c4834
140
+
Comentariile de acest tip ne permit să înțelegem scopul funcției și să o folosim în modul corect fără a ne uita în codul ei.
141
+
142
+
Apropo, multe editoare precum [WebStorm](https://www.jetbrains.com/webstorm/) le pot înțelege la fel de bine și să le folosească pentru a furniza autocomplete și câteva verificări automate ale codului.
143
+
144
+
De asemenea, sunt și unelte precum [JSDoc 3](https://github.com/jsdoc3/jsdoc) care pot genera documentație HTML din comentarii. Poți citi mai multe informații despre JSDoc la <https://jsdoc.app>.
183
145
184
-
De ce este rezolvată sarcina în modul acesta?
146
+
De ce este rezolvată sarcina în acest mod?
185
147
: Ce este scris este important. Dar ce *nu* este scris s-ar putea să fie mult mai important pentru a înțelege ce se îmtâmplă. De ce este sarcina rezolvată în felul acesta? Codul nu oferă nici un răspuns.
186
148
187
149
Dacă sunt multe moduri de a rezolva sarcina, de ce tocmai acesta? În special când nu este chiar cel mai evident.
@@ -202,20 +164,16 @@ Un semn important al unui dezvoltator bun sunt comentariile: prezența lor și c
202
164
203
165
Comentariile bune ne permit să păstrăm codul organizat, să ne întoarcem la el după un timp și să îl folosim mult mai eficient.
204
166
205
-
**Folosește comentariile pentru:**
167
+
**Comentează următoarele:**
206
168
207
169
- Arhitectura per total, o vedere de ansamblu a acesteia.
208
170
- Utilizarea funcțiilor.
209
171
- Soluții importante, în special când nu sunt imediat evidente.
210
172
211
173
**Evită comentariile pentru:**
212
174
213
-
<<<<<<< HEAD
214
-
- Pentru a descrie "cum funcționează codul" și "ce face".
215
-
- Folosește-le doar dacă este imposibil să faci codul atât de simplu și autodescriptiv încât comentariile să nu mai fie necesare.
216
-
=======
217
-
- That tell "how code works" and "what it does".
218
-
- Put them in only if it's impossible to make the code so simple and self-descriptive that it doesn't require them.
219
-
>>>>>>> 29216730a877be28d0a75a459676db6e7f5c4834
175
+
- Pentru a spune "cum funcționează codul" și "ce face".
176
+
- Punele înăuntru doar dacă este imposibil să faci codul atât de simplu și autodescriptiv încat nu este nevoie de ele.
177
+
220
178
221
-
Comentariile sunt de asemenea folosite pentru unelte de autodocumentare precum JSDoc3: acestea le citesc și generează documentații HTML (sau documentații în alt format).
179
+
Comentariile sunt de asemeni folosite pentru unelte de autodocumentare precum JSDoc3: acestea le citesc și generează documentații HTML (sau documentații în alt format).
0 commit comments