Comentariu (computer)
Comentariul , în contextul limbajelor de programare , face parte din codul sursă care are ca unic scop descrierea caracteristicilor sale funcționale sau pentru a explica funcționarea liniilor de cod ulterioare și care nu face parte din algoritmul soluției codificat în limbajul de programare . În timpul procesului de compilare , aceste instrucțiuni sunt ignorate și, în consecință, nu cântăresc din punct de vedere calculatic dimensiunea executabilului produs. Aceste notații particulare sunt foarte importante, mai ales dacă programul este dezvoltat de persoane diferite și în momente diferite, sporind lizibilitatea / inteligibilitatea acestuia pentru cititor și favorizând astfel întreținerea acestuia. Comentariile sunt, de asemenea, utilizate pentru a inhiba executarea unor porțiuni de cod, de obicei făcute în așteptarea unei reabilitări ulterioare a codului inhibat.
Prezentare generală
Comentariile sunt, în general, formatate ca comentarii bloc (numite și comentarii prolog sau comentarii flux ) sau comentarii liniare (numite și comentarii inline ) [1] .
Comentariile de bloc delimitează o zonă a codului sursă care poate cuprinde mai multe linii sau o porțiune dintr-o singură linie. Această regiune este specificată cu un început și un sfârșit DELIMITER. Unele limbaje de programare (cum ar fi MATLAB) vă permit să cuibăriți recursiv comentariile blocate unul în celălalt, dar altele (cum ar fi Java) nu [2] [3] [4] .
Comentariile de linie încep cu un delimitator de comentarii și continuă până la sfârșitul liniei sau, în unele cazuri, încep de la o coloană specifică (offset de linie de caractere) din codul sursă și continuă până la sfârșitul liniei [4] .
Unele limbaje de programare folosesc comentarii de bloc și linie cu diferite delimitatori de comentarii. De exemplu, C ++ are /* și */ comentarii bloc delimitate care pot acoperi mai multe linii și // comentarii linii delimitate. Alte limbi acceptă doar un tip de comentariu. De exemplu, comentariile Ada sunt comentarii de linie: încep cu -- și continuă până la sfârșitul liniei [4] .
Eliberare de stres
Uneori programatorii adaugă comentarii pentru a ameliora stresul comentând instrumentele de dezvoltare, concurenții, angajatorii, condițiile de muncă sau calitatea codului în sine. Apariția acestui fenomen poate fi văzută cu ușurință din resursele online care urmăresc limbă în codul sursă [5] .
Descriere
Limbaje de programare
Fiecare limbă are propria sintaxă pentru a permite programatorului să introducă comentarii în cod. Tabelul de mai jos prezintă indicațiile referitoare la unele dintre cele mai utilizate limbaje de programare și markup [6] .
| Limba | Comentariu unic | Comentariu pe mai multe linii |
|---|---|---|
| Asamblare | ; | |
| Autoit | ; | #cs #ce |
| DE BAZĂ | REM sau ' | |
| Bash | # | |
| C. | // | / * * / |
| C ++ | // | / * * / |
| Cobol | * în a șaptea coloană | |
| Fortran | ! | |
| HTML | <! - -> | |
| Java și JavaScript | // | / * * / |
| Matlab | % | % {...%} |
| Pascal | {} sau (* *) | |
| PHP | // sau # | / * * / |
| Piton | # | "" "" "" |
| YAML | # | # |
Probleme de siguranta
În limbile interpretate, comentariile pot fi vizualizate de utilizatorul final al programului. În unele cazuri, cum ar fi secțiunile de cod „comentate”, acest lucru ar putea prezenta o vulnerabilitate de securitate [7] .
Reguli
Există diferite puncte de vedere normative și opinii de lungă durată privind utilizarea corectă a comentariilor în codul sursă [8] [9] . Unele dintre acestea sunt informale și se bazează pe preferințe personale, în timp ce altele sunt publicate sau promulgate ca linii directoare formale pentru o anumită comunitate [10] .
Ai nevoie de comentarii
Experții au opinii diferite cu privire la dacă și când comentariile sunt adecvate în codul sursă [11] [12] . Unii susțin că codul sursă ar trebui să fie scris cu câteva comentarii, pe baza faptului că codul sursă ar trebui să fie auto-explicativ sau auto-documentat [11] . Alții sugerează că codul trebuie comentat pe larg (nu este neobișnuit ca mai mult de 50% din caracterele care nu sunt spațiale în codul sursă să fie conținute în comentarii).
Printre aceste puncte de vedere se află afirmația că comentariile nu sunt nici benefice, nici dăunătoare în sine și ceea ce contează este că sunt corecte și păstrate în sincronizare cu codul sursă și omise dacă sunt inutile, excesive, greu de păstrat sau altfel inutile. .
Comentariile sunt uneori folosite pentru a documenta contractele în abordarea proiectării cu contract a programării.
Exemplu
/ * Run all „inapoi raită prin toate elementele returnate de server
(Trebuie să fie prelucrate în ordine cronologică) * /
for ( i = ( numElementsReturned - 1 ); i > = 0 ; i - ) {
/ * Prelucrează datele fiecărui element * /
updatePattern ( i , returnElements [ i ]);
}
Notă
- ^ JB Dixit, Computer Fundamentals and Programming in C , Laxmi Publications, 2003, ISBN 978-81-7008-882-0 .
- ^ Desmond Higham, MATLAB Guide , SIAM, 2005, ISBN 978-0-89871-578-1 .
- ^ Al Vermeulen, Elementele stilului Java , Cambridge University Press, 2000, ISBN 978-0-521-77768-1 .
- ^ a b c Folosind comentariul corect în Java , la javadude.com , 4 martie 2000. Accesat la 24 iulie 2007 .
- ^ Numărul de cuvinte kernel Linux , la www.vidarholen.net . Adus la 15 martie 2021 .
- ^ Jessica Keyes, Software Engineering Handbook , CRC Press, 2003, ISBN 978-0-8493-1479-7 . discută comentarii și „Știința documentării” p. 256.
- ^ Mandy Andress, Surviving Security: How to Integrate People, Process, and Technology , CRC Press, 2003, ISBN 978-0-8493-2042-2 .
- ^ Pete Goodliffe, Code Craft , San Francisco, No Starch Press, 2006, ISBN 978-1-59327-119-0 .
- ^ T. Smith, Principii și tehnici de programare intermediară folosind Pascal , Belmont, West Pub. Co, 1991, ISBN 978-0-314-66314-6 .
- ^ Vezi de exemplu, Peter Koletzke, Oracle Developer Advanced Forms & Reports , Berkeley, Osborne / McGraw-Hill, 2000, ISBN 978-0-07-212048-6 . pagina 65.
- ^ a b Elementele stilului de programare , Kernighan & Plauger
- ^ Cea mai proastă practică - Comentarii greșite , la sqlservercentral.com . Adus 24-07-2007 .
