Podczas prac z wykorzystaniem wielu technologii czy języków programowania zauważymy, że każda z nich ustalone ma pewne reguły i zasady odnośnie sposobu pisania kodu. Co najważniejsze, nie ma jednego standardu kodowania dla danego języka programowania, ponieważ może być ich kilka. Dlaczego jednak te standardy kodowania są tak ważne?
Czym są standardy kodowania?
Najpierw, należy zacząć od definicji. Standardy kodowania są po prostu zbiorem zasad i reguł określających jak napisany przez programistę kod powinien wyglądać. Możemy podzielić je na kilka przykładowych grup:
- formatowanie kodu - wszelkiego rodzaju zabiegi stylistyczne jak: odstępy, wcięcia, maksymalna długość linii, umiejscowienie klamer,
- konwencje nazewnicze - w jaki sposób nazywane są pliki, katalogi, klasy, funkcje czy zmienne,
- komentowanie kodu - definicje w jaki sposób należy dodawać do kodu komentarze, przede wszystkim dla narzędzi, które na podstawie tych komentarzy tworzą dokumentację projektu.
Głównym zadaniem standardów kodowania jest sprawienie, aby napisany kod był przejrzysty i łatwy w zrozumieniu dla osób, które będą musiały z nim pracować. Może on sprawić, że nowa osoba, która dołączy do projektu lub go przejmuje, będzie w stanie szybko zorientować się w tym, co poprzedni autor miał na myśli.
Nie ma jednego standardu
Niestety, jak wiele jest języków programowania, tak i standardów kodowania jest wiele i niejednokrotnie jeden język posiada ich kilka. Jest to związane z tym, że każda z firm, które pracują z danym językiem, może dla niego opracować swój własny standard kodowania, jak również ustalić pewne reguły tylko dla jednego projektu.
Weźmy na przykład taką korporację jak Google, która posiada ponad 10 standardów kodowania dla różnych technologii / języków. Oczywiście podobnej wielkości firmy również je posiadają, ale moim zdaniem, one mogą sobie na to pozwolić. Problem wg mnie pojawia się w mniejszych firmach, które głównie działają lokalnie i nie zatrudniają wielkiej rzeszy programistów, a wprowadzają własne standardy kodowania.
Wewnętrzne reguły mogą okazać się dla nowo zatrudnionych osób niepotrzebną sprawą, którą muszą ogarnąć podczas wdrażania się do pracy, ponieważ osoby początkujące w programowaniu z pewnością miały już styczność ze standardami, które są ogólnie wykorzystywane na całym świecie. Jednak jeśli weźmiemy pod uwagę osoby już doświadczone zatrudniające się w takiej firmie, to zauważymy, że problem może być dokładnie taki sam, ponieważ dana osoba przywykła już do pisania inaczej wyglądającego kodu.
Kolejnym problemem jest freestyle, który przejawia się tym, że każda osoba w firmie pisze po swojemu. Wówczas wdrożenie się w taki projekt, przy którym mogło wcześniej pracować kilka osób, jest nie lada wyzwaniem. Związanym z tą kwestią jest też nawyk jednej osoby do standardów kodowania w jednym języku i próbowanie na siłę przeniesienie ich do innej technologii. W ten sposób otrzymujemy w projekcie prawdziwy bałagan, w którym przykładowo aplikacja androidowa wygląda jakby była napisana nie w Javie, a w C#.
Porządek jest najważniejszy
Nie ważne gdzie piszemy kod, ważne jest to, żeby był on przejrzysty i łatwy w zrozumieniu dla innych osób. Jeśli miejsce, w którym pracujemy, narzuca nam pewne standardy kodowania, musimy się do nich podporządkować, aby wszystkie projekty były spójne. Podczas swoich własnych prac lub kiedy nie jesteśmy zmuszeni do przyjęcia narzuconych standardów, starajmy się pisać kod, który będzie standardami pokrywał się ze zdecydowaną większością projektów w tej technologii czy języku i nie twórzmy dziwnych “potworków”, które sprawią, że nasz kod dla innych osób pracujących w tej samej technologii będzie kompletnie niezrozumiały.