pytanie do uczących się piszących programy :)

[obca1]

czy do napisanego kodu programu wskazane jest zrobienie jakiegoś opisu? jak wygląda od początku do końca taki napisany programik? nie chodzi mi o sam kod ale co jeszcze powinno się tam znaleźć :)

[retfos]

Zgodnie z prawidłami sztuki każda metoda czy funkcja powinna mieć opisane
parametry, co oblicza i wynik. w praktyce warto jeszcze w komentarzach opisywać
wszystko co się dzieje, a przynajmniej najważniejsze momenty, pętle, warunki i
opisywać co się dzieje w danym momencie z punktu widzenia algorytmu.
Zależy jakiego programu dotyczy Twoje pytanie. Jeśli jest to prosty program na
zaliczenie na studia to myślę, że wystarczy opisać w kodzie kluczowe momenty
algorytmu żeby sprawdzający się nie czepiał. Jeśli ma to być program dla Ciebie,
to zastanów się które momenty mogą być kluczowe dla zrozumienia programu bo z
doświadczenia wiem, że po miesiącu siadając do programu, który znało się jak
własną kieszeń nie pamieta się prawie nic :) Jeśli ma to być profesjonalny
program to najlepiej wykorzystać notację charakterystyczną dla danego języka,
jak np. notację dla javadoca w javie. Wtedy wskazane jest opisywać dokładnie
wszystko przy użyciu odpowiednich tagów, choć często nie ma na to czasu...