Re: Narzędzia do wizualizacji systemów Embedded

Newsgroups	pl.comp.programming
Date	2021-04-05 23:48 -0700
References	(10 earlier) <ef31edca-80b2-45fa-be5c-3b8a3522acedn@googlegroups.com> <3c9199cd-da3a-442a-b9e3-e016ad28b7f8n@googlegroups.com> <ba7bbd79-47e7-4df4-b906-f9642edc0a79n@googlegroups.com> <s4d9qt$blm$1@news.icm.edu.pl> <fbc62c89-79e5-48e0-8dd6-863bfd5c029an@googlegroups.com>
Message-ID	<70c173ca-4497-4220-a8fd-8973617a292dn@googlegroups.com> (permalink)
Subject	Re: Narzędzia do wizualizacji systemów Embedded
From	Maciek Godek <godek.maciek@gmail.com>

Show all headers | View raw

poniedziałek, 5 kwietnia 2021 o 19:10:47 UTC+2 Maciej Sobczak napisał(a):

> > Kod źródłowy może być 
> > samokomentujący,
> Na tej samej zasadzie co deska o długości 1.2m jest samokomentująca, bo przecież widać, że ma 1.2m.

O, wyśmienity przykład.
Jeżeli masz system oznaczania desek (np. naklejasz albo wypalasz oznaczenie na elemencie), i zaprojektujesz oznaczenia w ten sposób, że masz deskę typu A, deskę typu B, itd., to będziesz potrzebował dodatkowej dokumentacji, żeby sobie przetłumaczyć "typ" deski na jej wymiar. Natomiast jeżeli zamiast "A" napiszesz na desce "120x15x2", i deska będzie miała wymiary 120cm x 15cm x 2cm, to nie będziesz potrzebował tej dodatkowej dokumentacji.

W programowaniu jest podobnie, tylko że bardziej. Wcześniej pisałeś tak:

> Oczywiście można zrobić tak: 
> 
> int maxNumberOfBananasThatTheCustomerXYZAskedForAtTheLastMeeting = 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. 

Teraz zwróć uwagę, że zamiast "maxNumberOfBananas" mogłeś użyć np. nazwy "x" albo "mnb". Ale tego nie zrobiłeś, bo "x" ani "mnb" nie wyjaśniałoby roli rzeczonej zmiennej (którą jest -- jak bym chciał wierzyć -- maksymalna liczba bananów w jakimś kontekście)  wymagałaby dodatkowego źródła. Dlatego też nazwa zmiennej (będąca częścią kodu źródłowego, a nie tylko logistycznie współwystępującym elementem w kodzie źródłowym -- i oczywiście o ile jest poprawnie użyta) dokumentuje rolę tej zmiennej w systemie.

Rzecz jasna jest tak, że kod źródłowy może dokumentować zachowanie systemu lepiej albo gorzej (podobnie jak każda inna dokumentacja może być napisana lepiej albo gorzej), ale stąd nie wynika, że -- jak uparcie twierdzisz (mimo że nie wskazują na to ŻADNE materiały źródłowe, na które dotychczas próbowałeś się powoływać) -- przez sam fakt swojej potencjalnej wykonywalności (bądź bycia przetwarzalnym do jakiejś postaci wykonywalnej) -- nie może być dokumentacją.

Wydaje mi się też, że Twoja teoria miałaby problem z wyjaśnieniem istnienia tego artykułu na osławionej Wikipedii:

https://en.wikipedia.org/wiki/Self-documenting_code

Nota bene, swego czasu popełniłem na Wikipedii artykuł, który pokazywał, jak przejść od kodu, który dokumentuje siebie w komentarzach, do takiego, który jest samo-dokumentujący:

https://www.quora.com/What-are-some-examples-of-bad-code/answer/Panicz-Godek

Oczywiście nie jest tak, że sprawa nie jest w jakimś stopniu osobliwa: jak wpiszesz w wyszukiwarkę "self-documenting", to główną podpowiedzią (przynajmniej u mnie) jest właśnie "code", i wygląda na to, że -- poza kodem źródłowym -- niewiele jest innych artefaktów, które mogłyby mieć potencjał "dokumentowania siebie samych" (choć np. w wielu książkach widziałem sekcję pt. "jak używać tej książki", którą poniekąd można postrzegać jako dokumentację książki do niej samej)

Back to pl.comp.programming | Previous | Next — Previous in thread | Next in thread | Find similar

Thread

Narzędzia do wizualizacji systemów Embedded Maciek Godek <godek.maciek@gmail.com> - 2021-03-24 04:15 -0700
  Re: Narzędzia do wizualizacji systemów Embedded heby <heby@poczta.onet.pl> - 2021-03-24 13:33 +0100
  Re: Narzędzia do wizualizacji systemów Embedded Adam M <amorawski@magna-power.com> - 2021-03-24 09:28 -0700
    Re: Narzędzia do wizualizacji systemów Embedded Maciek Godek <godek.maciek@gmail.com> - 2021-03-24 12:33 -0700
      Re: Narzędzia do wizualizacji systemów Embedded Maciej Sobczak <see.my.homepage@gmail.com> - 2021-03-25 08:41 -0700
        Re: Narzędzia do wizualizacji systemów Embedded Maciek Godek <godek.maciek@gmail.com> - 2021-03-25 09:18 -0700
          Re: Narzędzia do wizualizacji systemów Embedded Maciej Sobczak <see.my.homepage@gmail.com> - 2021-03-26 09:16 -0700
            Re: Narzędzia do wizualizacji systemów Embedded Maciek Godek <godek.maciek@gmail.com> - 2021-03-26 09:47 -0700
              Re: Narzędzia do wizualizacji systemów Embedded Maciej Sobczak <see.my.homepage@gmail.com> - 2021-03-27 08:39 -0700
        Re: Narzędzia do wizualizacji systemów Embedded Adam M <amorawski@magna-power.com> - 2021-03-25 14:43 -0700
          Re: Narzędzia do wizualizacji systemów Embedded Maciej Sobczak <see.my.homepage@gmail.com> - 2021-03-26 09:41 -0700
            Re: Narzędzia do wizualizacji systemów Embedded Adam M <amorawski@magna-power.com> - 2021-03-26 14:57 -0700
            Re: Narzędzia do wizualizacji systemów Embedded Roman Tyczka <romantyczka@hate.you.spammer> - 2021-03-27 11:46 +0100
              Re: Narzędzia do wizualizacji systemów Embedded Maciej Sobczak <see.my.homepage@gmail.com> - 2021-03-27 08:51 -0700
  Re: Narzędzia do wizualizacji systemów Embedded Maciej Sobczak <see.my.homepage@gmail.com> - 2021-03-24 10:30 -0700
    Re: Narzędzia do wizualizacji systemów Embedded Maciek Godek <godek.maciek@gmail.com> - 2021-03-24 12:45 -0700
      Re: Narzędzia do wizualizacji systemów Embedded Maciej Sobczak <see.my.homepage@gmail.com> - 2021-03-25 08:54 -0700
        Re: Narzędzia do wizualizacji systemów Embedded Maciek Godek <godek.maciek@gmail.com> - 2021-03-25 09:30 -0700
          Re: Narzędzia do wizualizacji systemów Embedded Maciej Sobczak <see.my.homepage@gmail.com> - 2021-03-26 09:26 -0700
            Re: Narzędzia do wizualizacji systemów Embedded Maciek Godek <godek.maciek@gmail.com> - 2021-03-26 09:49 -0700
              Re: Narzędzia do wizualizacji systemów Embedded Maciej Sobczak <see.my.homepage@gmail.com> - 2021-03-27 09:08 -0700
                Re: Narzędzia do wizualizacji systemów Embedded Maciek Godek <godek.maciek@gmail.com> - 2021-03-28 13:40 -0700
                Re: Narzędzia do wizualizacji systemów Embedded Maciej Sobczak <see.my.homepage@gmail.com> - 2021-03-29 09:39 -0700
                Re: Narzędzia do wizualizacji systemów Embedded Maciek Godek <godek.maciek@gmail.com> - 2021-03-30 01:41 -0700
                Re: Narzędzia do wizualizacji systemów Embedded Maciej Sobczak <see.my.homepage@gmail.com> - 2021-03-30 14:00 -0700
                Re: Narzędzia do wizualizacji systemów Embedded Maciek Godek <godek.maciek@gmail.com> - 2021-03-31 01:42 -0700
                Re: Narzędzia do wizualizacji systemów Embedded slawek <x.y@org.org> - 2021-04-04 23:07 +0200
                Re: Narzędzia do wizualizacji systemów Embedded Maciej Sobczak <see.my.homepage@gmail.com> - 2021-04-05 10:10 -0700
                Re: Narzędzia do wizualizacji systemów Embedded Maciek Godek <godek.maciek@gmail.com> - 2021-04-05 23:48 -0700
                Re: Narzędzia do wizualizacji systemów Embedded Maciek Godek <godek.maciek@gmail.com> - 2021-04-06 00:21 -0700
                Re: Narzędzia do wizualizacji systemów Embedded Maciej Sobczak <see.my.homepage@gmail.com> - 2021-04-06 09:35 -0700
                Re: Narzędzia do wizualizacji systemów Embedded Maciek Godek <godek.maciek@gmail.com> - 2021-04-06 14:46 -0700
                Re: Narzędzia do wizualizacji systemów Embedded Maciej Sobczak <see.my.homepage@gmail.com> - 2021-04-07 13:07 -0700
                Re: Narzędzia do wizualizacji systemów Embedded Maciek Godek <godek.maciek@gmail.com> - 2021-04-08 03:57 -0700
                Re: Narzędzia do wizualizacji systemów Embedded slawek <x.y@org.org> - 2021-04-09 12:07 +0200
                Re: Narzędzia do wizualizacji systemów Embedded Maciej Sobczak <see.my.homepage@gmail.com> - 2021-04-09 07:57 -0700
                Re: Narzędzia do wizualizacji systemów Embedded slawek <x.y@org.org> - 2021-04-09 18:44 +0200
                Re: Narzędzia do wizualizacji systemów Embedded Maciej Sobczak <see.my.homepage@gmail.com> - 2021-04-10 07:26 -0700
                Re: Narzędzia do wizualizacji systemów Embedded Maciek Godek <godek.maciek@gmail.com> - 2021-04-11 14:57 -0700
                Re: Narzędzia do wizualizacji systemów Embedded Maciej Sobczak <see.my.homepage@gmail.com> - 2021-04-12 08:58 -0700
                Re: Narzędzia do wizualizacji systemów Embedded Maciek Godek <godek.maciek@gmail.com> - 2021-04-13 01:32 -0700
                Re: Narzędzia do wizualizacji systemów Embedded Maciej Sobczak <see.my.homepage@gmail.com> - 2021-04-13 08:50 -0700
                Re: Narzędzia do wizualizacji systemów Embedded Maciek Godek <godek.maciek@gmail.com> - 2021-04-13 13:57 -0700
                Re: Narzędzia do wizualizacji systemów Embedded Maciek Godek <godek.maciek@gmail.com> - 2021-04-16 02:26 -0700
                Re: Narzędzia do wizualizacji systemów Embedded Maciek Godek <godek.maciek@gmail.com> - 2021-04-12 02:45 -0700
                Re: Narzędzia do wizualizacji systemów Embedded Maciej Sobczak <see.my.homepage@gmail.com> - 2021-04-12 09:07 -0700
                Re: Narzędzia do wizualizacji systemów Embedded slawek <x.y@org.org> - 2021-04-04 22:32 +0200
        Re: Narzędzia do wizualizacji systemów Embedded slawek <x.y@org.org> - 2021-04-04 22:26 +0200

csiph-web