Dokumentacja kodu

Dokumentacja kodu
Noran
  • Rejestracja: dni
  • Ostatnio: dni
  • Postów: 42
0

W jaki sposób sensownie tworzyć dokumentację w trakcie pisania programu?

Koziołek
  • Rejestracja: dni
  • Ostatnio: dni
  • Lokalizacja: Stacktrace
  • Postów: 6823
AN
  • 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!

Noran
  • 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.

Koziołek
  • 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.

Noran
  • Rejestracja: dni
  • Ostatnio: dni
  • Postów: 42
0

Ok, dzięki za odpowiedzi :)

Zarejestruj się i dołącz do największej społeczności programistów w Polsce.

Otrzymaj wsparcie, dziel się wiedzą i rozwijaj swoje umiejętności z najlepszymi.