Polecicie coś do zapisywania dokumentacji? Chodzi mi o instrukcje do programów, procedury, przydatne informacje itd.. Wydaje mi się, że coś, co wykorzystuje składnię markdown byłoby najlepsze, bo potem mógłbym zmienić program,a pliki wynikowe byłoyby takie same
Do tej pory zapisywałem wszystko w osobnych plikach w notepad++, no ale to mało wygodne jest, bo zdjęcia to tam nie wrzucę
@bmLq: gówno a nie samo dokumentujący się kod. Jak udokumentujesz w kodzie dlaczego dana funkcja działa jak działa? Jak udokumentujesz założenia biznesowe, jak udokumentujesz proces architektoniczny, etc.
@becvvv: ja najczęściej robię sobie katalog doc/, który zawiera pliki Markdown/ASCIIDoc opisujące wszystko co nie pasuje jako docstring w kodzie. A tak to jak najwięcej staram się trzymać jako docstring, który potem jest w wygenerowanej dokumentacji.
Do tej pory zapisywałem wszystko w osobnych plikach w notepad++, no ale to mało wygodne jest, bo zdjęcia to tam nie wrzucę
#programowanie #programista15k #naukaprogramowania #praca #pracait #it #programujzwykopem
@becvvv: ja najczęściej robię sobie katalog
doc/, który zawiera pliki Markdown/ASCIIDoc opisujące wszystko co nie pasuje jako docstring w kodzie. A tak to jak najwięcej staram się trzymać jako docstring, który potem jest w wygenerowanej dokumentacji.¯\_(ツ)_/¯
obczaj to