Comments #20
Comments #20
Conversation
|
|
||
| We normally use them to describe how and why the code works. | ||
| Noi le folosim în mod obișnuit pentru a descrie cum și de ce codul funcționează. |
There was a problem hiding this comment.
Grammar suggestion : "de ce codul funcționează" -> "de ce funcționează codul"
|
|
||
| Novices tend to use comments to explain "what is going on in the code". Like this: | ||
| Începătorii tind să utilizeze comentariile pentru a explica "ce se întâmplă în cod". Ceva de genul: |
There was a problem hiding this comment.
Grammar suggestion : "Ceva de genul" -> "Ceva de genul ăsta"
| @@ -65,21 +63,21 @@ function isPrime(n) { | |||
| } | |||
| ``` | |||
|
|
|||
| Now we can understand the code easily. The function itself becomes the comment. Such code is called *self-descriptive*. | |||
| Acum putem înțelege codul mult mai ușor. Funcția în sine a devenit comentariul. Acest tip de cod se numește *autodescriptiv*. | |||
There was a problem hiding this comment.
Grammar suggestion : "Funcția în sine" -> "Funcția însăși"
| @@ -89,8 +87,7 @@ for(let t = 0; t < 3; t++) { | |||
|
|
|||
| // ... | |||
| ``` | |||
|
|
|||
| Then it might be a better variant to refactor it into functions like: | |||
| O variantă mai bună ar fi să îl separi în funcții precum: | |||
There was a problem hiding this comment.
Grammar suggestion:
"O variantă mai bună ar fi să îl separi în funcții precum:"
->
"Atunci ar putea exista o variantă mai bune de a-l refactoriza în funcții, precum:
| @@ -111,70 +108,70 @@ function addJuice(container) { | |||
| } | |||
| ``` | |||
|
|
|||
| Once again, functions themselves tell what's going on. There's nothing to comment. And also the code structure is better when split. It's clear what every function does, what it takes and what it returns. | |||
| Î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ă. | |||
There was a problem hiding this comment.
Grammar suggestion: "însuși" ->"însăși"
|
|
||
| In reality, we can't totally avoid "explanatory" comments. There are complex algorithms. And there are smart "tweaks" for purposes of optimization. But generally we should try to keep the code simple and self-descriptive. | ||
| Î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. |
There was a problem hiding this comment.
Grammar suggestion: "încercări" -> "ajustări"
| Describe the architecture | ||
| : 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 diagram language [UML](http://wikipedia.org/wiki/Unified_Modeling_Language) for high-level architecture diagrams. Definitely worth studying. | ||
| Descrierea arhitecturii | ||
| : 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. |
There was a problem hiding this comment.
Grammar suggestions:
"diagramă specială a limbajului" -> "limbaj-diagramă special"
"Se merită studiul acestora" -> "Cu siguranță merită studiate"
| Document a function usage | ||
| : There's a special syntax [JSDoc](http://en.wikipedia.org/wiki/JSDoc) to document a function: usage, parameters, returned value. | ||
| Documentarea utilizării unei funcții | ||
| : Există o sintaxă specială [JSDoc](http://en.wikipedia.org/wiki/JSDoc) pentru a scrie documentația unei funcții: utilizare, parametri, valoare returnată. |
There was a problem hiding this comment.
Grammar suggestion: "pentru a scrie documentația" -> "pentru a documenta"
| ```js | ||
| /** | ||
| * Returns x raised to the n-th power. | ||
| * Returnează x șa puterea n. |
There was a problem hiding this comment.
Typo fix: "șa puterea n" -> "la puterea n"
|
|
||
| If there are many ways to solve the task, why this one? Especially when it's not the most obvious one. | ||
|
|
||
| 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. |
There was a problem hiding this comment.
Typo fix: "verificărri" -> "verificări"
| Fără asemenea comentarii următoarea situație este posibilă: | ||
| 1. Tu (sau colegul tău) deschizi codul scris acum ceva timp, și vezi că este "suboptimizat". | ||
| 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ă". | ||
| 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. |
There was a problem hiding this comment.
Grammar suggestion: "actualmente" -> "defapt"
|
|
||
| Any subtle features of the code? Where they are used? | ||
| : If the code has anything subtle and counter-intuitive, it's definitely worth commenting. | ||
| Orice caracteristică subtilă a codului? Unde este folosită? |
There was a problem hiding this comment.
Grammar suggestion:
" Orice caracteristică subtilă a codului ? Unde este folosită ?"
->
"Orice caracteristici folosite ale codului ? Unde sunt folosite ?"
| Any subtle features of the code? Where they are used? | ||
| : If the code has anything subtle and counter-intuitive, it's definitely worth commenting. | ||
| Orice caracteristică subtilă a codului? Unde este folosită? | ||
| : În cazul în care codul are ceva subtil sau neintuitiv, atunci este necesară comentarea. |
There was a problem hiding this comment.
Grammar suggestion: "neintuitiv" -> "contraintuitiv"
|
Please make the requested changes. After it, add a comment "/done". |
|
/done |
|
Thank you 💖 I updated the Progress Issue #1 🎉 🎉 🎉 |
No description provided.