[C++] Pisanie czytelnego kodu :: Kompendium / Polski Serwis Naukowy

Polecamy również:

[TEORIA ZBIORÓW] Pojęcie zbioru, działania na zbiorach

[MECHANIKA KLASYCZNA] Prędkość i szybkość średnia

Programista C++, chyba jak żaden inny, ma ogromną swobodę w pisaniu kodu. Jest to niewątpliwie duża zaleta C++, jednak niemądry programista może ową dużą zaletę szybko przekształcić w jeszcze większą wadę. Oto przykładowy program:

#include <iostream>
#include <string>

using namespace std;

int main()
{
int n; // liczba wysiwetlen
string imie; // imie usera
cout << ''Podaj imie: '';
cin >> imie;
cout << ''Podaj liczbe wyswietlen: '';
cin >> n;
for (int i=1; i<=n; i++) // Pętla wyświetla n-razy podane imie
cout << ''Witaj '' << imie << endl;
return 0;
}

Jak widać kod jest czytelny, zaopatrzony w komentarze ułatwiające zrozumienie. Spójrzmy teraz, jak można ten sam program napisać w sposób niewłaściwy:

#include <iostream> #include <string>
using
namespace
std; int main()
{ int n;
string imie; cout << ''Podaj imie: '';
cin >> imie;
cout << ''Podaj liczbe wyswietlen: ''; cin >> n;
for
(int i=1; i<=n; i++) cout
<<
''Witaj '' <<
imie << endl; return 0;}

Próba odczytania takiego kodu może być prawdziwą gehenną, nawet dla samego autora. Należy więc się wystrzegać pisania takiego, jak na drugim przykładzie. Umiejętność pisania czytelnego kodu jest w świecie programowania prawdziwą cnotą (notabene wymaganą przez każdego pracodawcę z branży informatyki). Należy więc robić wszystko, aby kod był jak najbardziej zrozumiały. Oto kilka prostych rad:

Komentarze. Oczywiście nie trzeba komentować każdej linijki kodu. Jednak komentowanie funkcji czy pętli po przez opisanie jej działania, jest rzeczą jak najbardziej wskazaną.
Nazwy. Odpowiednie nazwy stałych, zmiennych, tablic, funkcji, działają podobnie jak komentarze. Nie ważne z jakiej liczby funkcji nasz program się składa. Odpowiednie nazwy ułatwiają czytanie kodu oraz chronią nas przed ewentualnymi błędami. Dlatego też, np. zamiast deklarować zmienną o nazwie izt, lepiej zadeklarować ile_zjadl_tata. Poszczególne wyrazy rozdzielamy łącznikiem (białe znaki, podobnie jak polskie, są niedopuszczalne), używamy tylko małych liter. Jest to jedna z najbardziej powszechnych i czytelnych form zapisu.
Wcięcia. Wcięcia zwiększają czytelność kodu szczególnie w przypadku zagnieżdżeń, np. pętli lub instrukcji warunkowych. Większość kompilatorów automatycznie wykonuje wcięcia w następnej linijce po znaku { . Jeśli jednak Twój kompilator tego nie robi, wykonuj je samodzielnie.
Funkcje. Odpowiednie dzielenie programu na funkcje ma mnóstwo zalet. Jedną z nich jest zwiększenie czytelności kodu. Jeśli więc masz taką możliwość, staraj się funkcji main nie zaśmiecać. Traktuj ją bardziej jako miejsce wywoływania poszczególnych funkcji.
Deklaracje. Staraj się deklarować zmienne, stałe, itp. na początku funkcji. Dzięki temu programista, niebędący autorem kodu, może przewidzieć dalszą treść kodu i tym samym łatwiej ją zrozumieć.

Początkujący programista szybko przekonuje się, że stosowanie powyższych rad jest niezwykle korzystne. Warto więc się z nimi na stałe zapoznać, ponieważ każdy dobry programista ma moralny obowiązek się do nich stosować.

Bibliografia:
Stephen Prata, Szkoła Programowania. Język C++, wyd. Helion, ISBN 83-7361-958-5

komentuj publikację