Kod HTML, PHP czy jakikolwiek inny jest zazwyczaj skomplikowany, jak sobie poradzić z większą ilością skomplikowanego kodu?

Przy kodowaniu w dowolnym języku musimy mieć na uwadze następujące problemy:

• z czasem ilość kodu się będzie znacznie rozrastać
• możemy być zmuszeni do dokonania poprawek po długim czasie, gdy nie będziemy już pamiętać w jaki sposób kod został zorganizowany
• kod może po nas przejąć inna osoba, która będzie go rozwijać
• dołączą do nas inne osoby, które będą rozwijać kod
• będzie trzeba całkowicie zmienić wygląd witryny/aplikacji

Dokumentacja kodu
Podstawa, o której większość koderów zapomina. Dobry kod powinien posiadać swoją dokumentację oraz komentarze w samym kodzie. Jeśli piszesz więcej komentarzy i dokumentacji niż właściwego kodu - to bardzo dobrze, wiele zespołów przyjmie cię z otwartymi ramionami. Można (i warto) wspomagać się narzędziami ułatwiającymi tworzenie dokumentacji typu Doxygen.

Rozdzielenie części wizualnej od reszty kodu
Problem większości osób początkujących, piszących proste strony w języku PHP. W tej chwili rodzielenie tych dwóch części kodu jest standardem. Jeśli zaczynasz naukę PHP - poświęć szczególną uwagę na to zagadnienie, możesz skorzystać z popularnego wzrorca projektowego MVC (model, widok, kontroler).

Konwencje przy nazewnictwie
Nazwy zmiennych, funkcji w PHP, klas w CSS mogą mieć dowolne nazwy. Wybierz nazwy tych elementów w taki sposób, aby faktycznie odzwierciedlały to, za co są w kodzie odpowiedzialne. Unikaj niezrozumiałych skrótów. Dłuższa nazwa jest lepsza niż nic niemówiący skrót.

Konwencje przy formatowaniu kodu
Zarówno HTML jak i PHP nie wymagają ścisłego formatowania kodu, dwie osoby, które będą musiały napisać to samo, napiszą go zupełnie inaczej o ile się nie umówią wcześniej jakich zasad się trzymać. Takie zasady są normą w każdej szanującej się firmie, która tworzy oprogramowanie. Standardem jest wcinanie kodu, przy czym wcięcie powinno być wielkości 4 spacji, większość edytorów kodu pozwala na wstawianie tych spacji tabulatorem.

System kontroli wersji
Gdy odkryjesz to narzędzie, przestaniesz sobie wyobrażać pisanie kodu bez niego. Dzięki tym systemom każda zmiana w kodzie jest rejestrowana, można powracać do starszych wersji (co umożliwia testowanie np. wydajności), lepiej organizować pracę w grupie, wiadomo kto jakie zmiany wprowadził do kodu.

Powyższe uwagi pomogą zachować porządek w kodzie, ułatwią jego zrozumienie oraz ułatwią organizację.