Când programați pe un computer, uneori este necesar să lăsați note sau comentarii, astfel încât alți dezvoltatori să poată răsfoi codul dvs. cu ușurință. Fie că este vorba de un proiect open source sau un proiect proprietar, sunt necesare comentarii pentru a se coordona cu co-dezvoltatorii și posibilii viitori dezvoltatori. Fără comentarii, codul ar fi pur și simplu imposibil de întreținut.
Pași
Pasul 1. Înțelegeți scopul comentării unui program de computer
- Citibilitatea este elementul cheie aici. Când priviți un comentariu, trebuie să știți că este un comentariu și nu o linie de cod.
- Comentariul ar trebui, de asemenea, să fie util nu doar pentru dvs., ci pentru oricine altcineva care ar putea citi codul sursă al programului dvs. de computer.
Pasul 2. Gândește-te la o modalitate scurtă și simplă de a trece peste punctul tău
Comentariile nu trebuie să fie o operă de artă. Ar trebui să fie concise, îngrijite și drepte la obiect.
Totuși, acest lucru nu ar trebui să descurajeze utilizarea mai multor linii pentru un comentariu. Ideea este că informațiile trebuie să ajungă la cititor
Pasul 3. Scrieți comentariul utilizând sintaxa adecvată dată de limbajul de programare
Pasul 4. Întrebați-vă dacă comentariul pe care l-ați scris este suficient de detaliat
Un comentariu ar trebui să poată spune cuiva care se uită la codul sursă ce face de fapt acea parte a programului fără a fi nevoie să îl compilezi și să îl rulezi. Comentariul dvs. realizează acest lucru? Transmite toate detaliile?
