-
X-Received: by 10.49.58.129 with SMTP id r1mr572qeq.31.1387661195765; Sat, 21 Dec
2013 13:26:35 -0800 (PST)
X-Received: by 10.49.58.129 with SMTP id r1mr572qeq.31.1387661195765; Sat, 21 Dec
2013 13:26:35 -0800 (PST)
Path: news-archive.icm.edu.pl!agh.edu.pl!news.agh.edu.pl!newsfeed2.atman.pl!newsfeed.
atman.pl!goblin2!goblin.stu.neva.ru!feeder.erje.net!us.feeder.erje.net!usenet.b
lueworldhosting.com!feeder01.blueworldhosting.com!peer02.iad.highwinds-media.co
m!news.highwinds-media.com!feed-me.highwinds-media.com!p15no37898460qaj.0!news-
out.google.com!l9ni207qay.0!nntp.google.com!p15no37898453qaj.0!postnews.google.
com!glegroupsg2000goo.googlegroups.com!not-for-mail
Newsgroups: pl.comp.programming
Date: Sat, 21 Dec 2013 13:26:35 -0800 (PST)
In-Reply-To: <l94p0t$61v$1@node2.news.atman.pl>
Complaints-To: g...@g...com
Injection-Info: glegroupsg2000goo.googlegroups.com; posting-host=188.47.255.52;
posting-account=VFwkXwoAAADdT4-lLKRZrMYkTjizGoyn
NNTP-Posting-Host: 188.47.255.52
References: <l94p0t$61v$1@node2.news.atman.pl>
User-Agent: G2/1.0
MIME-Version: 1.0
Message-ID: <5...@g...com>
Subject: Re: Wasze breakpointy do tworzenia komentarzy ?
From: Wojciech Muła <w...@g...com>
Injection-Date: Sat, 21 Dec 2013 21:26:35 +0000
Content-Type: text/plain; charset=ISO-8859-2
Content-Transfer-Encoding: quoted-printable
X-Received-Bytes: 2656
X-Received-Body-CRC: 1499780416
Xref: news-archive.icm.edu.pl pl.comp.programming:204789
[ ukryj nagłówki ]On Saturday, December 21, 2013 8:09:07 PM UTC+1, Przemysłąw Dębski wrote:
> Wiadomo wszem i wobec, że w trakcie piania kodu warto go opisywać
> komentarzami.
Nie no, poczytaj guru ruchu agile, niejakiego "Uncle Boba". Tenże
twierdzi, że im mniej komentarzy, tym lepiej. Bo komentarze to
dodatkowy koszt, bo trzeba aktualizować, itd.
> To są przypadki skrajne, pomiędzy którymi jest milion pierdylionów
> stanów pośrednich. Amatorskie podejście to "hmmm tego mogę kierdyś nie
> zakumać - opiszę", ale i "dam radę - szkoda czasu". Co może doprowadzić
> do tego, że z jednej strony opisujemy niepotrzebnie coś co i tak każdy
> przedszkolak zakuma lub z drugiej stony przeceniamy się i nie opisujemy
> czegoś do czego dzięki opisowi mogli byśmy "szybciej wrócić".
>
> Czy jest jakieś optymalne rozwiązanie ? Przestrzeń rozwiązań chyba spora :)
Staram się, żeby klasy w najprostszym przypadku posiadały opis do czego
ta klasa jest i ewentualnie w jakim miejscu jest używana (np. "wyznacza
różnice między obiektami Foo, używana wewnętrznie przez serwis FooDiff").
Chodzi o to, aby szybko orientować się w strukturze kodu.
W kodzie komentuję miejsca nieoczywiste, hacki i inne takie. Raz, że to
dokumentuje tę nieoczywistość, dwa unika się setnej odpowiedzi na pytania
w stylu "a czemu tak to idiotycznie napisałeś?".
w.
Następne wpisy z tego wątku
- 21.12.13 22:57 Przemysłąw Dębski
- 21.12.13 23:55 A.L.
- 21.12.13 23:56 A.L.
- 22.12.13 11:00 Andrzej Jarzabek
- 22.12.13 18:05 A.L.
- 22.12.13 20:28 R.e.m.e.K
- 22.12.13 21:47 A.L.
- 22.12.13 22:53 Andrzej Jarzabek
- 23.12.13 00:04 A.L.
- 23.12.13 03:10 Roman W
- 23.12.13 13:10 jacki
- 23.12.13 19:16 Wojciech Muła
- 16.01.14 09:28 Paweł Kierski
Najnowsze wątki z tej grupy
- "Wuj dobra rada" z KDAB rozważa: Choosing the Right Programming Language for Your Embedded Linux Device
- Nowa ustawa o ochronie praw autorskich - opis problemu i szkic ustawy
- Alg. kompresji LZW
- Popr. 14. Nauka i Praca Programisty C++ w III Rzeczy (pospolitej)
- Arch. Prog. Nieuprzywilejowanych w pełnej wer. na nowej s. WWW energokod.pl
- 7. Raport Totaliztyczny: Sprawa Qt Group wer. 424
- TCL - problem z escape ostatniego \ w nawiasach {}
- Nauka i Praca Programisty C++ w III Rzeczy (pospolitej)
- testy-wyd-sort - Podsumowanie
- Tworzenie Programów Nieuprzywilejowanych Opartych Na Wtyczkach
- Do czego nadaje się QDockWidget z bibl. Qt?
- Bibl. Qt jest sztucznie ograniczona - jest nieprzydatna do celów komercyjnych
- Co sciaga kretynow
- AEiC 2024 - Ada-Europe conference - Deadlines Approaching
- Jakie są dobre zasady programowania programów opartych na wtyczkach?
Najnowsze wątki
- 2025-03-23 Rozkaz 5-2025: O Umorzeniu Postępowania Sądowego
- 2025-03-23 Rozkaz 4-2025: O Ochronie Praw Autorskich
- 2025-03-23 Rozkaz 3-2025: O Zaprzestaniu Bratobójczych Walk Na Ukrainie
- 2025-03-23 Rozkaz 2-2025: O Zaprzestaniu Zaciągania Kredytów
- 2025-03-23 Rozkaz 1-2025: O Uchwaleniu Totaliztycznych Praw i Obowiązków Człowieka
- 2025-03-23 Waga z legalizacją
- 2025-03-23 Nowy VW 208 :-)
- 2025-03-23 ile Tesla ma gwarancji?
- 2025-03-22 OT Silnik sie przegrzewa
- 2025-03-22 Przenoszenie przez wifi na nowego Androida
- 2025-03-22 Warszawa => Senior Account Manager <=
- 2025-03-22 Wrocław => Konsultant wdrożeniowy Comarch XL (Logistyka, WMS, Produk
- 2025-03-22 Warszawa => Spedytor Międzynarodowy <=
- 2025-03-22 Warszawa => NMS System Administrator <=
- 2025-03-22 Warszawa => Analityk IT (projekty z obszaru telco) <=