Konwencja, pomimo że z samej nazwy brzmi jak coś topornego i nieprzyjemnego, jest wbrew pozorom czymś naprawdę… spoko. Można się do tego przekonać, choć nie ukrywam, że zawsze będzie budzić się w nas duch buntownika, który będzie chciał nagiąć standardy albo je złamać. Dlatego po angielsku przyjmuje się nieco lżejszą nazwę "code guideline" czyli "wskazówka" ale spróbuj ją złamać, to… Nic się nie stanie, jednak prędzej czy później pojawi się płacz.

Dla każdego języka przyjmuje się zupełnie inny zespół wskazówek, za pomocą których należy pisać kod. Idea jest jedna- kod pisany wg konwencji ma wyglądać tak, jakby był pisany przez jedną osobę. Dodatkowo konwencja rozwiązuje wątpliwości jak formatować kod w różnych przypadkach.

Piszę o zasadach akurat teraz, ponieważ kilka dni temu google wydało "JavaScript Style Guide". Dla niektórych jest to dokument, który jest co najmniej dyskusyjny i obawiałem się, że jestem w grupie tych osób. Po przeczytaniu zawartości okazało się, że "korzystam" z tych wskazówek od dłuższego czasu, jedynie w niektórych przypadkach odstaję od przykładów.

Co prawda dokument ten dotyczy tylko JS, jednak warto się z nim zapoznać chociażby pobieżnie, może natchnie on do zachowania standardu. Tutaj kilka punktów z dokumentu, które moim zdaniem są wspólne dla wszystkich języków:

• Nazwy plików: powinny być zapisywane wg underscore case, czyli pisane z małych liter a słowa oddzielane _ (lub -);
• Klamry (bloki): są obowiązkowe po wystąpieniu warunków lub pętli, jedyny wyjątek to brak klamer w momencie, gdy po warunku następuje zwrot wartości funkcji:

   if (true) return var;

  ;
• Wcięcia (indent): używa się wyłącznie spacji, jedno wcięcie to dwie spacje. Nie stosuje się znaków tabulacji (w IDE można ustawić, aby przycisk tabulatora wstawiał dwie spacje);
• Długość linii (line wrapping): jedna linia nie powinna być dłuższa niż 80 znaków. Kod powinien być "zawijany" tak, aby nie przekraczać 80 znaków w jednej linii);
• Białe znaki (wyrównywanie kodu): nie jest zalecane wyrównywanie kodu za pomocą spacji:

int zmienna = 3;
int foo      = 3;

Naturalnie to nie wszystkie rzeczy, ale moim zdaniem można je z powodzeniem stosować w niemalże każdym języku. Jakie są Twoje przemyślenia na ten temat? Podoba się Tobie ten standard, czy raczej czujesz się, że ktoś ogranicza Twoją wolność?