8
Jakie są dobre sposoby dokumentowania oprogramowania naukowego?
Wiele razy, kiedy odziedziczyłem lub napotkałem kod naukowy napisany przez innych ludzi (lub czasami nawet moją własną pracę), zauważyłem, że dokumentacja jest albo rzadka, albo nie istnieje. Jeśli mam szczęście, widzę pouczające komentarze. Jeśli mam szczęście, są nawet komentarze Doxygen i Doxyfile, więc mam interfejsy funkcyjne i trochę sformatowanego HTML …