Skip to content

Commit eb42c85

Browse files
author
Claudiu Sima
authored
Update article.md
1 parent ef12705 commit eb42c85

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

Diff for: 1-js/03-code-quality/03-comments/article.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
După cum știm din capitolul <info:structure>, comentariile pot fi pe o singură linie: începând cu `//` sau pe mai multe linii: `/* ... */`.
44

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.
66

77
La prima vedere, scrierea comentariilor pare a fi evidentă, dar adeseori începătorii în programare fac greșeli.
88

99
## Comentarii rele
1010

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:
1212

1313
```js
1414
// Acest cod va face asta (...) și asta (...)
@@ -63,7 +63,7 @@ function isPrime(n) {
6363
}
6464
```
6565

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*.
6767

6868
### Sfat: crează funcții
6969

@@ -87,7 +87,7 @@ for(let t = 0; t < 3; t++) {
8787

8888
// ...
8989
```
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:
9191

9292
```js
9393
addWhiskey(glass);
@@ -108,24 +108,24 @@ function addJuice(container) {
108108
}
109109
```
110110

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ă.
112112

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.
114114

115115
## Comentarii bune
116116

117117
Deci, comentarii explicative sunt de obicei rele. Ce comentarii sunt bune?
118118

119119
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.
121121

122122
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ă.
124124

125125
De exemplu:
126126
```js
127127
/**
128-
* Returnează x șa puterea n.
128+
* Returnează x la puterea n.
129129
*
130130
* @param {number} x Numărul ridicat la putere.
131131
* @param {number} n Puterea, trebuie să fie un număr natural.
@@ -138,7 +138,7 @@ Documentarea utilizării unei funcții
138138
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.
139139

140140

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.
142142

143143
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/>
144144

@@ -150,12 +150,12 @@ De ce este rezolvată sarcina în modul acesta?
150150
Fără asemenea comentarii următoarea situație este posibilă:
151151
1. Tu (sau colegul tău) deschizi codul scris acum ceva timp, și vezi că este "suboptimizat".
152152
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.
154154

155155
Comentariile care explică soluția sunt foarte importante. Te ajută să continui dezvoltarea în direcția cea bună.
156156

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.
159159

160160
## Rezumat
161161

0 commit comments

Comments
 (0)