Dokumentacja źródłem sukcesów w życiu ...

Dokumentacja jest tak jak w nagłówku źródłem sukcesów. Jest wręcz nie zastąpiona jako pomoc w rozumieniu kodu(choć są wyjątki od tej reguły). Dokumentacja pozwala zrozumieć biblioteki i różne inne projekty(samodzielnie). Czasami jest to dalekie od ideałów, gdy jest chaotyczna, niekompletna, pisana trudnym językiem, itd.. Faktem jest, że jej brak nie jest zbyt korzystny, ani dla twórcy(twórców) projektu, ani potencjalnego użytkownika(można wtedy konsultować się z autorem i dowiadywać się wszystkiego(oczywiście takie rozwiązanie przy dużej liczbie użytkowników, jest bardzo frustrujące dla wszystkich)). Wracając do tematu, czym jest właściwie dokumentacja kodu projektu? Otóż to wszelkie informacje o projekcie, opis kodu, itd.. Prostym sposobem dokumentowania są, uwaga: komentarze:) - to dzięki nim możliwa jest analiza kodu do którego powróciło się po kilku miesiącach. Lepszą formą opisu kodu w większych projektach są generatory dokumentacji, które za pomocą usystematyzowanych komentarzy jak sama nazwa wskazuje generują nam gotową dokumentację kodu w przejrzystej strony html lub innej przyjemnej dla oka formie. Godnym polecenia jest tutaj: Doxygen - darmowy, obsługuje wiele języków, posiada program(Doxywizard), który prowadzi nas przez proces tworzenia dokumentacji, posiada graficzny interfejs. Mały tutek jest na tej stronie: http://wierzba.miks.uj.edu.pl/~gurgul/doxygen/

I teraz zdanie podsumowujące: Dokumentacja jest bardzo ważnym elementem, który wpływa na wiele innych czynników, związanych mniej lub bardziej z projektem(np. popularności, która przy mało przejrzystej dokumentacji będzie prawdopodobnie bardzo niska).

Proszę  o uwagi , opinie związane z tematem dokumentacji. Chętnie dowiem się jak sprawa stoi u innych.