Tworzenie dokumentacji Opcje

[rad11]

Co wedlug was powinna posiadac dobra dokumentacja aplikacji? Czym sie kierujecie piszac taka dokumentacje? Co jest najwazniejsze? Czy korzystacie z jakis szablonow?

[SpiritCode]

Ja np.: pisząc dokumentację kieruję się opisami funkcji.
Jeśli klient wyamga aby dokumentacja była w osobnym pliku tekstowy zbieram wszystkie komentarze funkcji jakie piszę w czasie tworzenia kodu i w pliku je trochę rozszerzam o szczegóły, które w komentarzach do kodu były zbędne.
Jesli chodzi o schemat komentarzy to u mnie wygląda tak:

[PHP] pobierz, plaintext 
/**
* Zbieranie danych o kategoriach
*
* @param array $params tablica filtrów wyszukiwania
* 
* @return bool/array FALSE jeśli brak kategorii, jesli kategoria istnieje - tablica z danymi
*/
[PHP] pobierz, plaintext 

Wydaje mi się, że to standardowy komentarz do funkcji

Ten post edytował SpiritCode 29.01.2015, 08:05:39