PDL – o modalitate inteligenta de a comenta codul

 

Este cunoscut faptul ca pentru intretinerea usoara a unor programe de dimensiuni medii si mari este recomandat ca acestea sa fie cat mai bine comentate. Exista doua tendinte in aceasta privinta. Unii programatori prefera sa lase codul sa vorbeasca de la sine iar altii il aglomereaza cu prea multe comentarii. Fiecare metoda este gresita intr-o oarecare masura, calea corecta fiind undeva la mijloc. Codul trebuie scris astfel incat sa fie usor de inteles si trebuie sa aiba comentarii care sa delimiteze blocurile logice principale.

 

PDL ( Program design language ) este o modalitate dezvoltata de Caine, Farber & Gordon insa modificata substantial fata de prima aparitie. Este folosita de profesionisti in programare pentru a face codul mai usor de inteles. PDL corespunde pseudocodului. Metoda consta in a intercala liniile de program intre liniile de pseudocod corespunzatoare care devin astfel comentarii.

 

Pentru a intelege mai bine sa vedem un exemplu concret. Vom realiza o functie simpla care sa citeasca o linie dintr-un fisier. Vom folosi C++, dar mai intai sa realizam pseudocodul care va fi folosit drept comentariu. In linii mari functia trebuie sa faca urmatoarele :

1)      deschide fisier pentru citire

2)      verifica daca fisierul exista

3)      citeste linia de text din fisier

4)      afiseaza textul pe ecran

5)      inchide fisier

 

Pornind de la pseudocod este foarte usor de scris functia pentru ca deja stim ce

trebuie sa faca :

           

            // citeste o linie din fisier si o afiseaza pe ecran

            bool show_first_line( char * file )

            {

                        char buffer[ MAX_BUFF_SIZE ];

 

                        // deschide fisier pentru citire

                        fstream fin( file, ios::in);

 

                        // verifica daca fisierul exista

                        if( !fin ) return false;

 

                        // citeste linia de text

                        fin.getline(buffer, MAX_BUFF_SIZE);

 

                        // afiseaza pe ecran

                        cout << buffer <<endl;

 

                        // inchide fisierul

                        fin.close();

           

                        return true;

            }

 

            Usor ?! Codul este foarte clar fara sa fie supraincarcat de comentarii inutile. Mai trebuie precizat ca pseudocodul trebuie sa ramana independent de limbajul de programare in care este implementat. Folosirea acestei metode ajuta la scrierea unui cod usor de inteles fara comentarii care reformuleaza programul, de genul :

 

            a = a + 1;    // aduna 1 la variabila a

 

            Astfel de comentarii fac mai mult rau decat bine. Adevarata utilitatea a acestui stil de a comenta va fi resimtita atunci cand apare o problema in program sau cand acesta trebuie extins.

 

            Acesta este un exemplu stupid insa intr-o functie complexa beneficiile acestei metode sunt semnificative atunci cand trebuie cautat un bug, sau cand se doreste extinderea functionalitatii.

 

            Pentru mai multe informatii legate de acest domeniu vast al constructiei unei aplicatii va recomand cartea  “ Code Complete “ - Steve McConnell ,  o carte de referinta in domeniu si necesara tuturor celor care vor devine niste adevarati profesionisti in domeniu.

 

            Pana data viitoare va urez programare placuta si cat mai putine bug-uri. Orice mesaj il puteti trimite la savu.andrei@gmail.com si o sa va raspund cat de repede pot.