Să presupunem că lucrați în departamentul IT al unei companii mari. Șeful dvs. vă instruiește că trebuie să scrieți un program format din câteva mii de linii de cod sursă. După câteva săptămâni, veți termina programul și executați proiectul. După câteva luni, utilizatorii încep să observe că programul uneori cade. Ei se plâng la șeful tău și el, la rândul său, vă spune: trebuie să o rezolviți. După căutarea în arhiva proiectelor, găsiți un dosar cu fișiere text - codul sursă al programului. Din păcate, descoperiți că codul sursă nu are sens - este pur și simplu de neînțeles pentru dvs. De-a lungul anilor, ați lucrat în alte proiecte și nu vă puteți aminti de ce ați scris codul în acest fel. Decipitarea codului poate dura mai multe ore sau chiar zile, însă șeful are nevoie de rezultatul ieri. O mulțime de stres este inevitabil. Cum putem preveni acest lucru?
Acest stres poate fi evitat prin documentarea codului sursă cu descrieri semnificative. Și deși acest lucru este adesea trecute cu vederea, dar documentarea codului sursă atunci când scrieți logica programului este una dintre cele mai importante sarcini ale dezvoltatorului. Așa cum se poate vedea din exemplul meu, având în vedere timpul scurs de la scrierea codului, chiar și un programator excelent nu poate înțelege rațiunea din spatele unor soluții - de ce a făcut-o în acest fel și nu altfel.
Luați în considerare etichetele Javadoc utilizate frecvent:
Documentația generată include un fișier index (index.html), care este pagina de pornire. De exemplu, în figura de mai jos puteți vedea pagina de pornire din documentația de actualizare Java SE 8 din biblioteca API generată de Javadoc.
Articole similare
-
Cum să folosiți clase - colecții arrailist, vector și hashmap furnizate de colecțiile java
-
Cum se instalează java folosind apt-get în ubuntu, digitalocean
Trimiteți-le prietenilor: