Standardy kodowania
Niniejsze hasło traktuje o formatowaniu kodu źródłowego programu komputerowych. O kodowaniu plików i tekstu w komunikacji elektronicznej przeczytasz w hasłach kodowanie transportowe i strona kodowa.
 |
Ten artykuł wymaga dopracowania zgodnie z zaleceniami edycyjnymi. Należy w nim poprawić: dodać konkrety, a nie ogólniki. Po wyeliminowaniu wskazanych powyżej niedoskonałości prosimy usunąć szablon {{Dopracować}} z kodu tego artykułu. |
Standardy kodowania (pisania kodów źródłowych programów komputerowych) są to zasady służące do zunifikowania wyglądu i zachowania kodu. Standard kodowania może obejmować wiele aspektów kodu programu:
- formatowanie - np. szerokość wcięcia, maksymalna długość wiersza, liczba pustych wierszy między kolejnymi definicjami i deklaracjami funkcji, czy klas
- konwencje nazewnicze - schemat nazywania funkcji, klas, zmiennych, modułów, przestrzeni nazw, plików itp.; np. wymaganie by nazwa klasy zaczynała się zawsze wielką literą, zaś zmienne były zawsze pisane małymi literami;
- komentowanie kodu - sposób komentowania kodu, opisywania zmian, konieczność udokumentowania algorytmów użytych do rozwiązania konkretnego fragmentu kodu; styl komentowania być może zgodny z jakimś narzędziem automatycznie generującym dokumentację na podstawie komentarzy;
- konstrukcje programistyczne - zależne od języka programowania, obejmują polecane i zabraniane konstrukcje (wynikające np. z ograniczeń platformy docelowej lub użytych narzędzi programistycznych); np. w języku C czy C++ może to być zabronienie tworzenia makrodefinicji w plikach nagłówkowych, które potem mogłyby bez żadnej kontroli rozpropagować się na cały projekt.
Stosowanie standardów ma swoje wymierne znaczenie, szczególnie w dużych instytucjach i projektach programistycznych, w których rotacja kadr wymusza jednolitość kodowania. Przejęcie kodu od innego programisty nie wiąże się z wielogodzinnymi próbami zrozumienia "co autor miał na myśli".
Kod należy pisać jak najbardziej przejrzyście. Wszelkie skróty zaciemniają obraz programu i powodują, że osoba czytająca musi się domyślać znaczenia poszczególnych ciągów instrukcji z kontekstu. Ponadto sam autor po powrocie do swojego kodu nie traci w nim orientacji.