You are viewing a single comment's thread from:
RE: Czy i jak dokumentować kod część I
Programuje w javie i jak najbardziej zgadzam się z tym, że kod powinien się sam dokumentować. Moim zdaniem można jeszcze dodać paragraf o odpowiedniej dekompozycji i o zrozumieniu domeny, która zajmuję się program bez tego trudno pisać kod, który jest czytelny. W javie używamy swagera do dokumentowania API. Dziekuję @piotr-galas za dobry post .
Dzięki za cenne uwagi. Jeśli chodzi o dekompozycje, to przyznam że to nie mogłem o tym pisać ponieważ najzwyczajniej nie znałem takiego określenia. Przeglądając internent wywnioskowałem że sprowadza się to, do single responsibility principle. Popraw mnie jeśli się mylę.
Zrozumienie domeny to pewnie materiał na osobny artykuł. Pisanie kodu podnosi naszą wiedzę o domenie. Czasem nawet odkrywa nowe fakty. Generalnie jestem zdania że kod powinien 1:1 odzwierciedlać rzeczywistość, ale często nie jest to łatwe.
Tak jak napisałeś.