Wpisy z tagiem: społeczność

Zrezygnowałem z funkcji moderatora na 4programmers. Już od jakiegoś czasu o tym myślałem i dziś porzuciłem tę funkcję — dzięki temu będę miał nieco więcej spokoju oraz czasu na pracę nad swoim projektem gry, który jest dla mnie teraz najwazniejszy. Zanim jednak rozpęta się drama, od razu zaznaczę, że nie odchodzę z 4programmers — nadal zamierzam tu być, w wolnym czasie udzielać się w dyskusjach i smarować bzdurne wpisy na blogu. Jedyne co się zmienia to brak dostępu do narzędzi moderatorskich. ;)

A skoro już wspomniałem o projekcie gry, to troszkę niusów niżej.

Przez ostatnie 8-10 lat, kod w IDE miałem w skali szarości — niemal czarne tło oraz różne identyfikatory i literały jako jasno- lub ciemnoszare, słowa kluczowe i dyrektywy jako białe itd. Taki schemat kolorów był wystarczająco czytelny i nie męczył oczu. Jednak od dawna zanosiłem się z ustawieniem kodu kolorowego, bo zazdrościłem użytkownikom np. Visual Studio tego, że tak ciekawie, ładnie i czytelnie wygląda kod w tym IDE (i w wielu innych). Ale za każdym razem gdy kolorowałem kod w Lazarusie, wyglądał on beznadziejnie — z jednej strony raczej słabą przez funkcjonalność kolorowania składni w edytorze, a z drugiej strony przez brak sensownego pomysłu na kolorystykę. Za każdym razem wracałem więc do skali szarości.

Kod zawsze staram się pisać w taki sposób, aby sam się komentował, dlatego nigdy nie pisałem komentarzy, nawet jeśli projekt był relatywnie duży. Np. Richtris, który zawiera ponad 28 tysięcy linijek kodu, nie ma ani jednego komentarza (prócz nagłówków z informacjami o autorze). Przy okazji widać kawałek edytora kodu i kolorowanie składni, z jakiego korzystałem przez ostatnie lata (widać niezbyt wiele, ale innego zrzutu nie mam):

Czasem wracam do tego projektu i kopuję z niego jakieś rozwiązania na potrzeby innych projektów, ale pomimo tego, że jego kodu nie roszałem od dobrych dwóch lat, nie mam większego problemu ze zrozumieniem jak działa. Jednak to tylko pozory — o ile widzę co kod robi, to mogę nie wiedzieć dlaczego coś jest wykonywane, a tego sam kod mi już nie powie. No i dupa.

Swój nowy projekt postanowiłem pisać w ten sam sposób — porządnie formatować kod i pisać go w tak, aby było wiadomo jak działa. W teorii tyle wystarczy, jednak pisząc kod niskopoziomowy operujący na wskaźnikach, jego działanie może na pierwszy rzut oka nie być wcale takie oczywiste. Projekt rozrósł się dość mocno, obecnie mam ~6,500 LoC, rozsianych po 72 plikach. Do tej pory bez problemu ogarniałem jego strukturę i nie miałem żadnych problemów z jego zrozumieniem, jednak obawiałem się, że wraz z rozwojem projektu, kodu przybędzie dziesiątki tysięcy linijek, zacznę się w nim gubić i tracić czas na rozgryzanie tego jak działa. Postanowiłem więc, że jednak zacznę pisać komentarze, chyba po raz pierwszy w życiu. :D

Jeśli już je pisać, to najlepiej zrobić to już, póki jeszcze kodu jest relatywnie mało i wiem dokładnie jak działa. Zacząłem je pisać, szukając jakiegoś dobrego schematu i już na wstępie byłem rozczarowany. Po pierwsze tym, że to cholernie czasochłonne i nudne, a po drugie tym, że kod stał się przez te komentarze nieczytelny. Moje ówczesne, szaro-bure kolorwanie składni za mocno eksponowało komentarze, a za słabo eksponowało właściwy kod. To ostatecznie przesądziło o tym, aby w końcu zmienić kolorystykę kodu, bo inaczej utonę w tych komentarzach. :|

Dawniej przeglądałem w Google zrzuty z różnych IDE, szukałem inspiracji w paczkach dla VS, więc mniej więcej wiedziałem co i jak pokolorować. Niestety Pascal ma dość dziwną składnię w porównaniu np. do C++ czy Javy, a do tego Lazarus nie daje jakoś szczególnie dużo opcji związanych z różnymi elementami kodu. Ostatecznie zainpirował mnie highlighter używany w Stack Overflow, wykorzystujący tylko kilka kolorów — biały, pomarańczowy, zielony i niebieski, wszystko na niemal czarnym tle. Lubię wszystkie te kolory, szczególnie połączenie białego, pomarańczoweto i zielonego (jak dawne bolidy Force India w F1). Poeksperymentowałem trochę z tym który kolor do czego przypisać i jakie odcienie będą dobre, zważywszy na składnię Pascala, częstotliwość wystepowania danego koloru w docelowym kodzie oraz na jasność i konstrast używanych przez mnie wyświetlaczy. No i w końcu udało się — nareszcie mam kolory kod w IDE, który mnie nie obrzydza i który ładnie eksponuje właściwy kod, utrzymując komentarze nie rzucające się zbytnio w oczy:

Jeśli chodzi o same komentarze, to początkowo postanowiłem komentować tylko niektóre rzeczy — w nagłówku pliku ogólnie opisać co dany moduł zawiera, a w samym kodzie dodawać komentarze tylko z informacjami, o których sam kod nie mówi (czyli dlaczego coś jest wykonywane, dlaczego tak a nie inaczej itd.). Szybko jednak doszedłem do tego, że jednak lepiej jest opisać każdy aspekt i każdy element (ale bez przesady), bo w przyszłości nawet takie z pozoru oczywiste rzeczy mogą przestać być oczywiste i każdy komentarz będzie na wagę złota, bo pozwoli oszczędzić czas analizy kodu. Tak więc oprócz podawania ogólnych informacji, dodawałem komentarze również do deklaracji typów danych, stałych, nagłówków funkcji i opisywać ich argumenty, podawać tez nieoczywiste rzeczy oraz ważne informacje, o których sam kod nigdy nie powie. Nadźgałem tych komentarzy dość sporo i początkowo byłem sceptyczny, jednak po kilku dniach czuję, że komentarze są bardzo ważne i że na pewno w przyszłości pomogą mi utrzymywać kod. Tak więc jestem z nich zadowolony, bo był to krok w dobrą stronę. Szkoda tylko, że mój angielski trochę posysa i że często muszę z translatora korzystać — ale to nie jest problem, bo komentowanie idzie sprawnie, a korzystanie z translatora mimo wszystko pomaga uczyć się angielskiego.