Standardy kodowania – zestaw wytycznych służący do zunifikowania wyglądu, praktyk, struktury i zachowania kodu danej platformy programistycznej lub języka programowania, zazwyczaj popularyzowany przez ich deweloperów w celu ułatwienia komunikacji i wymiany kodu między nieznajomymi programistami[1].
Powszechne standardy
Większość standardów kodowania związana jest z odpowiadającym im językiem programowania. Przykładami takich standardów są:
- Python: PEP 8 – Style Guide for Python Code[2].
- C++: C++ Core Guidelines[3].
- Java: Java Programming Style Guidelines[4].
- C: SEI CERT C Coding Standard[5].
Standardy kodowania języków programowania zazwyczaj obejmują takie aspekty kodu jak:
- Formatowanie kodu – szerokość wcięcia, maksymalna długość wiersza, liczba pustych wierszy między kolejnymi definicjami i deklaracjami funkcji bądź klas.
- Konwencje nazewnicze – schemat nazywania funkcji, klas, zmiennych, modułów, przestrzeni nazw, plików i tym podobnych.
- Komentowanie kodu – sposób komentowania kodu, opisywania zmian, konieczność udokumentowania algorytmów użytych do rozwiązania konkretnego fragmentu kodu.
- Konstrukcje programistyczne – zależne od języka programowania, obejmują polecane i zabraniane konstrukcje, wynikające na przykład z ograniczeń platformy docelowej lub użytych narzędzi programistycznych.[6]
Zalety standardów kodowania
Korzystanie ze standardów kodowania zmniejsza koszty związane z konserwacją oprogramowania, zwiększa jakość kodu poprzez ułatwianie jego zrozumienia przez bardziej doświadczonych deweloperów, przyśpiesza proces jego restrukturyzacji oraz umożliwia deweloperom na płynniejsze korzystanie z narzędzi automatyzacji ich pracy[7]. Standardy kodowania szczególnie wymagane są podczas pracy w dużych instytucjach i projektach programistycznych, w których występuje częsta rotacja kadr.
Zobacz też
Przypisy
- ↑ Coding Standards For Quality and Compliance [online], Perforce Software [dostęp 2022-03-13] (ang.).
- ↑ PEP 8 – Style Guide for Python Code | peps.python.org [online], peps.python.org [dostęp 2022-03-13] .
- ↑ C++ Core Guidelines [online], isocpp.github.io [dostęp 2022-03-13] .
- ↑ Java Programming Style Guidelines [online], geosoft.no [dostęp 2022-03-13] .
- ↑ SEI CERT C Coding Standard - SEI CERT C Coding Standard - Confluence [online], wiki.sei.cmu.edu [dostęp 2022-03-13] .
- ↑ Prince Sengayire , The importance of coding standards and conventions in the software development team, how they can… [online], Medium, 27 listopada 2019 [dostęp 2022-03-13] (ang.).
- ↑ Benefits of Using Coding Standards to Software Development Team [online], www.streetdirectory.com [dostęp 2022-03-13] .