W jaki sposób sensownie tworzyć dokumentację w trakcie pisania programu?
Dokumentacja kodu
- Rejestracja: dni
- Ostatnio: dni
- Lokalizacja: Stacktrace
- Postów: 6823
1
Standardowe narzędzie nr 1 JavaDoc > http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html
- Rejestracja: dni
- Ostatnio: dni
- Postów: 339
1
Pomaga w tym środowisko IDE, które potrafi wygenerować nagłówek dokumentacji, pozostaje uzupełnić opisy zmiennych i opis metod,klas.
Poza tym każdy język ma standardy dokumentowania, których warto się trzymać.
Do konkretnego języka znajdziesz w wyszukiwarce!
- Rejestracja: dni
- Ostatnio: dni
- Postów: 42
0
Chodzi ma bardziej o metodykę tworzenia dokumentacji. To tak jak z komentarzami, są te dobre i te niepotrzebne. Czy z dokumentacją jest podobnie? Zadając pytanie miałem na myśli jakąś... filozofię, tworzenia dobrej dokumentacji.
- Rejestracja: dni
- Ostatnio: dni
- Lokalizacja: Stacktrace
- Postów: 6823
1
Kod samo-dokumentujący się :) Co do reszty to wszystko zalezy od tego jaka zostanie przyjęta konwencja w ramach danego zespołu.