sobota, 27 marca 2021 o 17:08:22 UTC+1 Maciej Sobczak napisał(a):
> > "Documentation is any communicable material that is used to describe, explain or
instruct regarding some attributes of an object, system or procedure, such as its
parts, assembly, installation, maintenance and use"
> >
> > Kod źródłowy jest komunikowalny i może być użyty do wyjaśnienia pewnych atrybutów
systemu, więc nadal nie rozumiem.
> To jest pomysł tej samej warstwy społecznej, która wymyśliła "Working software over
comprehensive documentation" i ogólnie tej grupy, która systematycznie nie jest w
stanie zrobić sensownej dokumentacji, więc kombinuje jak by tu uzasadnić drobny fakt,
że jej po prostu nie ma.
>
> Kod źródłowy oczywiście, że może być komunikowalny. Ale nie jest w stanie wyjaśnić
"dlaczego" ani "w jakim celu", czyli nie jest w stanie niczego uzasadnić. Właśnie do
tego jest dokumentacja. Oczywiście można zrobić tak:
>
> int maxNumberOfBananasThatTheCustomerXYZAskedForAtTheLas
tMeeting = 12345;
>
> ale chyba rozumiemy, że taka nazwa to nie jest kod, tylko niewłaściwie użyty
komentarz. Czyli dokumentacja. I się pewnie zaraz rozjedzie.
> Można też tak:
>
> int maxNumberOfBananas = 12345;
>
> ale bez (rozjeżdżającej się) dokumentacji nie wiemy, dlaczego akurat tyle. A to
może być bardzo ważne.
> Zrobienie tego samego (w obu wersjach) na diagramie, który posłuży do
automatycznego wygenerowania takiego kodu niczego nie zmienia, tylko przenosi problem
w inne miejsce w procesie produkcyjnym.
>
> Kod programu nie jest dokumentacją. Diagram może być ilustracją w dokumentacji, ale
jeśli diagram służy do generowania kodu, to nie jest. Taki diagram nadal wymaga
dokumentacji.

Nadal nie wyjaśniłeś dlaczego nie jest.
Najpierw jak zapytałem, to wkleiłeś link do artykułu na Wikipedii, który twierdzi, że
dokumentacją jest wszystko, co służy do wyjaśnienia działania jakiegoś systemu.
Teraz drugi raz twierdzisz, że jeżeli diagram posłuży do wygenerowania kodu, to nagle
w jakiś magiczny sposób przestaje być dokumentacją (co w świetle definicji z
Wikipedii oznaczałoby, że nie może już służyć do rozumienia działania systemu, bo
wówczas... byłby dokumentacją).

Z tego co widzę, swoje uzasadnienie opierasz na ad hominem względem jakiejś grupy
ludzi, która kiedyś coś twierdziła, oraz na tym, że kod źródłowy nie dokumentuje
wszystkich aspektów budowy i użytkowania systemów. No to teraz uważaj:
żadna dokumentacja nie dokumentuje wszystkich aspektów budowy i użytkowania systemów.

W szczególności, można znaleźć dużo dokumentacji, która również nie wyjaśnia,
dlaczego albo w jakim celu danego komponentu systemowego można użyć. Weźmy pierwszy z
brzegu przykład - podręcznik do funkcji "memcpy"

https://man7.org/linux/man-pages/man3/memcpy.3.html

Opisuje różne aspekty użycia funkcji `memcpy`, ale nie wyjaśnia, dlaczego ta funkcja
powstała, ani w jakim celu się ją stosuje.

Nie zmienia to jednak faktu, że ta strona manuala jest dokumentacją. (Chyba że zaraz
stwierdzisz, że nie jest)

Twój przykład z "niewłaściwie użytym komentarzem" może też pokazuje gdzie może leżeć
źrodło nieporozumienia.
Bo nie wiem jak Ty, ale ja swoje komentarze do kodu źródłowego zazwyczaj trzymam w
kodzie źródłowym.
One *są częścią* kodu źródłowego, i wyjaśniają rzeczy, których w samym języku
programowania nie mógłbym wyrazić, albo tłumaczą, skąd się wzięły jakieś nieoczywiste
rozwiązania.