Polecają:

Jak skutecznie programować – część I: Komentuj!

04 grudnia 2009 § 4

lf_programowanie_01122009

Ten artykuł to pierwsza część informacji dla każdego początkującego programisty. Część pierwsza opisuje jak ważne jest komentowanie kodu.

Moja historia z językami programowania zaczęła się od Actionscript 2 silnie związanego z Flashem. I tam pierwszy raz spotakałem się z komentarzami. Komentarz nie odgrywa żadnej ro li przy odbiorze kody przez przeglądarki, lecz jest bardzo przydatnym elementem podczas pracy z czystym kodem.

Gdy chcemy komentować musimy pamiętać o kilku zasadach:

1. Gdy komentujemy używając:

// to nasz komentarz może się znajdować wyłącznie na tej samej linijce za tym kodem

2. Gdy komentujemy używając:

/*

to nasz komentarz może znajdować się

na wielu linia pomiędzy tymi znakami

Pamiętaj o zamykaniu znaczników komentarza w tym przypadku

*/

3. Przemyśl swój komentarz! Zamiast komentować elementy kodu po tym gdzie się znajdują opisz je funkcjami jakie spełnia, np.

NIE //małe prawe czerwone przyciski

TAK //funkcje odpowiedzialne za działanie main menu

Dlaczego komentarz jest taki ważny:

1. Praca nad kodem to nieustanne zmiany dokonywane czasami przez wielu różnych programistów. Nie rób innym problemów w przeszukiwaniu kodu w celu zmiany jakiegoś drobnego elementu. W trakcie swojej pracy robiłem zmiany na wielu stronach klientów, gdzie pierwotny kod został napisany przez innych programistów… Brak komentarzy daje się mocno we znaki, gdy pięć razy szukasz potrzebnego fragmentu kodu w 30 plikach!

2. Nie utrudniaj samemu sobie! Czasami przy programowaniu wracamy do kodów, które zostały przez nas napisane miesiące a czasem lata wstecz. Dobr y i szczegółowy komentarz z opisaniem poszczególnych funkcji kodu pozwoli na szybkie odnalezienie się między linijkami kodu i zrozumienie co autor (w tym przypadku my sami) miał na myśli:)

Ten artykuł to pierwsza część z cyklu jak skutecznie programować. Artykuły te nie będą opisywać języków programowania oraz jak je używać. Mają one na celu przedstawić świat programowania od praktycznej strony użytkowania kodów oraz ich pisania w sposób przystępny dla każdego kto pragnię poznać świat programowania.

Jeżeli jesteś zainteresowany tematami, które poruszam na moim blogu, zawsze możesz darmowo subskrybować do mojego RSS, żeby dostać świeże artykuły od razu po ich ukazaniu.

Best Conversion Survey Site: Converts 1 In 7
zp8497586rq

§ 4 komentarzy do “Jak skutecznie programować – część I: Komentuj!”

Co to za artykuł?

Obecnie czytasz Jak skutecznie programować – część I: Komentuj! w Lime Factory.