Forum PHP.pl

Tylko trzeba pamiętać o tym, że ktoś kiedyś może będzie ten kod utrzymywał i Twoje "ulepszenia" mogą wtedy bardzo ten proces utrudnić

Skoro tak temat powędrował to ja przy okazji gorąco polecam: Clean Code: A Handbook of Agile Software Craftsmanship. Książka naprawdę bardzo dobra.
Niby opisane zasady i podpowiedzi tyczą się niemal podstaw, które dobry programista już dawno powinien osiągnąć to jednak nieźle trzepie po głowie. Ja mocno polepszyłem warsztat po przeczytaniu książki.
Pozycja z naciskiem na Javę (zawiera trochę tekstu, który dość mocno tyczy się tego języka) ale w ogólności kierowana dla użytkownika każdego języka.

Wiem, że mało adekwatny nieco, ale posłużę się linijką z kodu jaki już podałem i tyczy właśnie wyliczania niefortunnego $loops

[PHP] pobierz, plaintext 
$loops = min( $random_existance['count'], count($random_text) );
[PHP] pobierz, plaintext 

Dla siebie dodatkowo skomentowałem, że jest ono potrzebne w ramach zabezpieczenia. Może być bowiem sytuacja, że tekstów losowych jest podanych mniej niż wylosowana liczba. Niby drobiazg, ale bez niego w określonych sytuacjach kod się może wyłożyć. Komentarz tutaj informuje więc mnie, że jest to miejsce na które muszę zwrócić uwagę podczas ewentualnej optymalizacji kodu. Myślę, że ma tutaj więc uzasadnienie komentarz, gdyż jest to potencjalna pułapka w sytuacji dostarczania danych z zewnątrz. Ja dla siebie więc i późniejszego zrozumienia lubię stosować. Nie by pisać elaborat, ale gdy siadam po długim czasie znowu do kodu tegoż, wiedzieć co z czym zjeść. A takiej informacji konwencje nie obejmują. Konwencje tyczą bowiem czytelności kodu i pewnych podstawowych informacji, a nie jego głebszej warstwy logiczno-informacyjnej tak naprawdę. Z samego nazewnictwa, układu kodu i jego ustrukturyzowania tego nie uzyskam w żaden sposób.

Jakbyś zrobił z tego funkcję (opisaną przez jej nazwę):

[PHP] pobierz, plaintext 
<?php
 
class SomeClass {
    private function calculateRandomNumbersCount($randomExistance, $randomText) {
        return min( $randomExistance['count'], count($randomText) );
    }
}
 
?>
[PHP] pobierz, plaintext 

... to użycie komentarza już nie jest takie oczywiste. Aczkolwiek racja, troszeczkę pomocne.

Ten post edytował mike 13.10.2011, 10:34:19

Gdybym oparł o klasy lub robił specjalnie funkcje, choć wiem, że dany kod będzie wykonywany jednokrotnie przez całe wywołanie funkcji i nigdzie indziej w kodzie, to fakt, miało by to jakiś sens. Jak jednak wspomniałem, świadomie zrezygnowałem z warstwy abstrakcji i zamykania wszystkiego w funkcje celem minizowania wszelkich narzutów czasowych, a takim wypadku cierpi czytelność. Zyskuje na czasie wykonania, tracę na połapaniu się w kodzie i chcąc, nie chcąc, przy takim podejściu komentarze stają się niemal obowiązkiem. Gdyby nie ten fakt, który stanął jako podwalina, to zrobiłbym zapewne jak mówisz i ładnie bym się trzymał standardów OOP. A tak jedyną pomocą jaką mogłem zastosować było trzymanie konwencji nazewnictwa, choć i tu mi się zdarzyło walnąć gdzieniegdzie byczka

Czyli brniesz w negatywne skutki poprzednich błędnych decyzji I brniesz dalej i dalej ...
W programowaniu bardzo łatwo nadziać się na efekt stłuczonej szyby.

thek czy dodanie jednej klasy i kilku metod będzie zauważalnym narzutem w wykorzystaniu zasobów, czasu działania?

Moim zdaniem będzie to bardzo daleka pozycja po przecinku. Czas poświęcony na pisanie komentarzy, albo później przy każdej zmianie - na wgryzanie się w kod, będzie dużo dłuższy i będzie generował dużo większe koszty niż dodatkowa pamięć czy czas serwera.

@mike: jeśli nie naprawiałbym "dziur", to masz rację "Problem" w tym, że skrypt jest kompletny i nie wymaga poprawek od strony logiki. Jedyne które mogą go dotknąć tyczą się właśnie optymalizacji wydajnościowych. Albo wtedy poprawiam czytelność i obniżam wydajność, albo na odwrót. W moim wypadku wybrałem to "na odwrót"
@vokiel: masz częściowo rację. Z tym, że komentarze piszę tak, że nawet kompletny debil by zrozumiał Siadając po nawet roku do kodu i mając poprawne nazewnictwo oraz takie komentarze nie miałbym prawa się nie połapać w chwilę co zrobiłem