Przydatny jest dokument standardów kodowania. Jest to najbardziej przydatne, gdy jest wystarczająco krótkie, aby każdy mógł zapamiętać całą sprawę bez większych problemów i gdy nie powoduje to zbytniego bólu.
To, jak wybierzesz wcięcie kodu w swojej organizacji, wielkie litery, implementację pętli lub komentowanie kodu, nie ma aż tak wielkiego znaczenia; pomocną częścią jest zachęcenie wszystkich do napisania kodu, który wygląda mniej więcej tak samo jak wszystkich innych.
- Pozwala to uniknąć konieczności ponownej kalibracji oczekiwania na to, gdzie powinny znajdować się nawiasy klamrowe i za każdym razem, gdy spojrzysz na kod innej osoby.
- Pozwala to uniknąć posiadania kilku różnych stylów kodu w jednym pliku.
- Być może, co najważniejsze, posiadanie pisemnego standardu pozwala uniknąć dyskusji na temat praktyk kodowania podczas przeglądów kodu.
Ponownie, standardy nie mają tak dużego znaczenia, jak posiadanie jakiegoś prostego, prostego standardu. Tak więc umieść wszystkich programistów w pokoju i pozwól im spierać się o standardy. Spotkanie może trwać w nieskończoność, więc zasady są następujące:
- O wszelkich decyzjach pod koniec spotkania decyduje kierownik.
- Spotkanie zakończy się po dwóch godzinach lub gdy ktoś zacznie krzyczeć lub płakać, w zależności od tego, co nastąpi wcześniej.
- Cały standard zmieści się (w rozsądnym rozmiarze!) Na arkuszu lub dwóch arkuszach papieru, dwustronnie tylko w razie absolutnej konieczności.
Rozważ przyjęcie kogoś | inne | standardy albo jako punkt wyjścia do spełnienia własnych standardów kodowania, albo jako sposób na całkowite uniknięcie spotkania.
Po uzgodnieniu programiści powinni mieć możliwość (i należy oczekiwać, że) sami siebie nadzorują. Sporadyczne odstępstwa od normy nie powinny być wielką sprawą (a nawet być uzasadnione), ale zuchwała odmowa rezygnacji z ulubionego osobistego stylu na rzecz normy powinna skutkować natychmiastowym przeniesieniem do biura z nieszczelnymi rurami wodnymi lub czymkolwiek innym .
Demian Brecht wskazuje na kłaczki. Stanowią one doskonałe uzupełnienie dokumentu standardów kodowania. Po prostu dobrze jest trzymać się standardów stylu kodowania ; to ważne , aby trzymać się standardów kodowania, które odnoszą się do niebezpiecznych praktyk. Nikt inny niż autor nie sprawdzi, czy każda linia kodu odpowiada standardowi stylu, ale z pewnością powinieneś rozważyć wbudowanie narzędzia do szuflady w obieg pracy zespołu, aby automatycznie wychwytywać potencjalne błędy. Ponadto samo narzędzie może kodyfikować przyjęte praktyki, abyś nie musiał wymieniać ich wszystkich indywidualnie w standardach kodowania; wystarczy określić konfigurację narzędzia.
Uwaga: Idea „standardów kodowania” nie dotyczy wyłącznie programowania. „Standardy kodowania” są stosowane w wielu dziedzinach, czasem w organizacji, częściej w całej branży lub zawodzie. Kilka przykładów:
W każdym przypadku (i wielu innych) kompetentny lekarz może łatwo zrozumieć „kod”, który nie spełnia oczekiwanego standardu. Dlaczego tak wiele branż upiera się przy pisaniu szczegółowych wymagań dotyczących dokumentów, które nawet nie muszą być analizowane przez kompilator? Ponieważ styl ma znaczenie . Prezentacja informacji w standardowym stylu pozwala czytelnikowi skupić się całkowicie na treści, przyspiesza czytanie, ułatwia zrozumienie i zmniejsza liczbę błędów.