Comments good, bad and ugly

Komentarze w kodzie

Najważniejszy drogowskaz, przy dodawaniu komentarzy w kodzie, to słowa, które przeczytałem kiedyś na jednym z polskich blogów:
Komentarze są, żeby napisać dlaczego coś robię, a nie jak coś robię
(nie pamiętam originału, ale tak to się w mojej głowie zapamiętało i może być dla kogoś bardziej wartościowe niż oryginał ;)) W mojej praktyce częściej usuwam komentarze niż tworzę własne.

Bardziej chciałem rzucić linkiem ze StackOverflow What is the best comment in source code you have ever encountered?

Ten jeden link dał mi naprawdę dużo radości. Czytając te odpowiedzi można się nieźle rozerwać. Warto jednak od razu czytać te komentarze pod odpowiedziami, z nich można się też czegoś nauczyć.

Chciałem wrzucić komentarz, który mnie bardzo rozbawił, ale niestety topic jest już zamknięty. Podzielę się więc tutaj:

<!--
This code features:
- inline styles
-  blocks
- multiple  blocks
- almost no comments
- <br>'s

I'm a trained proffesional, don't try this at home...

Konrad
-->

Ten komentarz pokazuje mi doskonale, że prawdziwi zawodowcy wiedzą, że w nieprodukcyjnym kodzie nie stosuje się na gwałt wyszukanych technik, tylko zmierza prosto do celu. Czasem ktoś Cię zmusza, żeby napisać szybko kod, a czasem sam wiesz, że ma być szybko i nigdy nie wrócisz do tego.

Reklamy
Ten wpis został opublikowany w kategorii Programowanie i oznaczony tagami , . Dodaj zakładkę do bezpośredniego odnośnika.