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
+13-13
Original file line number
Diff line number
Diff line change
@@ -2,13 +2,13 @@
2
2
3
3
După cum știm din capitolul <info:structure>, comentariile pot fi pe o singură linie: începând cu `//` sau pe mai multe linii: `/* ... */`.
4
4
5
-
Noi le folosim în mod obișnuit pentru a descrie cum și de ce codul funcționează.
5
+
Noi le folosim în mod obișnuit pentru a descrie cum și de ce funcționează codul.
6
6
7
7
La prima vedere, scrierea comentariilor pare a fi evidentă, dar adeseori începătorii în programare fac greșeli.
8
8
9
9
## Comentarii rele
10
10
11
-
Începătorii tind să utilizeze comentariile pentru a explica "ce se întâmplă în cod". Ceva de genul:
11
+
Începătorii tind să utilizeze comentariile pentru a explica "ce se întâmplă în cod". Ceva de genul ăsta:
12
12
13
13
```js
14
14
// Acest cod va face asta (...) și asta (...)
@@ -63,7 +63,7 @@ function isPrime(n) {
63
63
}
64
64
```
65
65
66
-
Acum putem înțelege codul mult mai ușor. Funcția în sine a devenit comentariul. Acest tip de cod se numește *autodescriptiv*.
66
+
Acum putem înțelege codul mult mai ușor. Funcția însăși a devenit comentariul. Acest tip de cod se numește *autodescriptiv*.
67
67
68
68
### Sfat: crează funcții
69
69
@@ -87,7 +87,7 @@ for(let t = 0; t < 3; t++) {
87
87
88
88
// ...
89
89
```
90
-
O variantă mai bună ar fi să îl separi în funcții precum:
90
+
Atunci ar putea exista o variantă mai bune de a-l refactoriza în funcții, precum:
91
91
92
92
```js
93
93
addWhiskey(glass);
@@ -108,24 +108,24 @@ function addJuice(container) {
108
108
}
109
109
```
110
110
111
-
Încă o dată, însuși funcțiile ne spun ce se întâmplă. Nu e nimic de comentat. De asemenea, structura codului este mai bună când este împărțită. Este clar ce face fiecare funcție, ce primește și ce returnează.
111
+
Încă o dată, însăși funcțiile ne spun ce se întâmplă. Nu e nimic de comentat. De asemenea, structura codului este mai bună când este împărțită. Este clar ce face fiecare funcție, ce primește și ce returnează.
112
112
113
-
În realitate, nu putem evita în totalitate comentariile "explicative". Există algoritmi complecși. Și există și "încercări" deștepte cu scopul optimizării. Dar în general ar trebui să încercăm să păstrăm codul simplu și autodescriptiv.
113
+
În realitate, nu putem evita în totalitate comentariile "explicative". Există algoritmi complecși. Și există și "ajustări" deștepte cu scopul optimizării. Dar în general ar trebui să încercăm să păstrăm codul simplu și autodescriptiv.
114
114
115
115
## Comentarii bune
116
116
117
117
Deci, comentarii explicative sunt de obicei rele. Ce comentarii sunt bune?
118
118
119
119
Descrierea arhitecturii
120
-
: 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ă o diagramă specială a limbajului [UML](https://ro.wikipedia.org/wiki/Unified_Modeling_Language) pentru diagrame de nivel înalt. Se merită studiul acestora.
120
+
: 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
121
122
122
Documentarea utilizării unei funcții
123
-
: Există o sintaxă specială [JSDoc](http://en.wikipedia.org/wiki/JSDoc) pentru a scrie documentația unei funcții: utilizare, parametri, valoare returnată.
123
+
: Există o sintaxă specială [JSDoc](http://en.wikipedia.org/wiki/JSDoc) pentru pentru a documenta funcțiile: utilizare, parametri, valoare returnată.
124
124
125
125
De exemplu:
126
126
```js
127
127
/**
128
-
* Returnează x șa puterea n.
128
+
* Returnează x la puterea n.
129
129
*
130
130
* @param {number} x Numărul ridicat la putere.
131
131
* @param {number} n Puterea, trebuie să fie un număr natural.
@@ -138,7 +138,7 @@ Documentarea utilizării unei funcții
138
138
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.
139
139
140
140
141
-
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ărri automate ale codului.
141
+
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.
142
142
143
143
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/>
144
144
@@ -150,12 +150,12 @@ De ce este rezolvată sarcina în modul acesta?
150
150
Fără asemenea comentarii următoarea situație este posibilă:
151
151
1. Tu (sau colegul tău) deschizi codul scris acum ceva timp, și vezi că este "suboptimizat".
152
152
2. Te gândești: "Ce stupid am fost atunci, și cât de deștept sunt acum", și rescrii codul folosind varianta "mult mai evidentă și corectă".
153
-
3. ...Impulsul de a rescrie codul a fost bun. Dar în continuarea dezvoltării observi că "cea mai evidentă soluție" este actualmente insuficientă. Îți amintești cu greu de ce, deoarece ai testat-o acum mult timp. Te întorci la varianta corectă, dar timpul a fost pierdut.
153
+
3. ...Impulsul de a rescrie codul a fost bun. Dar în continuarea dezvoltării observi că "cea mai evidentă soluție" este defapt insuficientă. Îți amintești cu greu de ce, deoarece ai testat-o acum mult timp. Te întorci la varianta corectă, dar timpul a fost pierdut.
154
154
155
155
Comentariile care explică soluția sunt foarte importante. Te ajută să continui dezvoltarea în direcția cea bună.
156
156
157
-
Orice caracteristică subtilă a codului? Unde este folosită?
158
-
: În cazul în care codul are ceva subtil sau neintuitiv, atunci este necesară comentarea.
157
+
Orice caracteristici folosite ale codului? Unde sunt folosite ?
158
+
: În cazul în care codul are ceva subtil sau contraintuitiv, atunci este necesară comentarea.
0 commit comments