W książce "clean code" czytałem, że komentarze powinny być stosowane jak najrzadziej i tylko wtedy, kiedy jest to konieczne. W kodzie opensourcowego frameworka "kohana" widziałem dokumnetację przed każdą klasą/funkcją i praktycznie każdą linijką kodu. Pytanie - jak poprawnie komentować kod (jeśli piszę coś, co będzie miało API i będzie wykorzystywane przez userów-programistów) ?
Głównie:
- pisać przed każdą klasą/funkcją, do czego służy?
- wypisywać parametry funkcji / zwracane wartości w dokumentacji ? (@param integer ...)
itp.