Co dokumentować?

0

Uczę się dobrych praktyk i zaczynam dokumentować kod w trakcie pisania, jednak mam parę wątpilwości:

  1. Czy interfejsy też dokumentować?
  2. Jeżeli mam klase, która jest zwykłym kontenerem i przechowuje we właściwościach zadokumentowane wcześniej obiekty, to te właściwości też dokumentować? Np "Tak, to jest właśnie ten obiekt" : D
4

Dokumentuj publiczne API, rzeczy nieoczywiste (ten kod robi taki myk, bo w bibliotece, której używamy jest bug) oraz stosowane nietypowe algorytmy, najlepiej od razu z odnośnikiem do literatury.

1 użytkowników online, w tym zalogowanych: 0, gości: 1