Rola komentarzy w kodowaniu.
Kiedy powstają kolejne linie kodu podczas programowania, warto co jakiś czas zaznaczyć i opisać czego
dotyczy określony jego fragment. Przydaje się to zwłaszcza w momencie, kiedy pojawiają się funkcje. Nie bez powodu mowa
o funkcjach właśnie w tym miejscu, ponieważ właśnie w tej grupie znajdziesz blok pozwalający wstawić komentarz.
W zasobniku w formie bloczku znajdziesz tylko komentarz pojedynczy. Podwójny można stworzyć wyłącznie w trybie tekstowym.
Bardziej czytelny kod.
Kiedy wejdzisz w tryb tekstowy, stworzysz kilka komentarzy, Twój kod będzie wygladał znacznie lepiej, przejrzyściej i będzie
bardzo czytelny i zrozumiały dla każdego, kto go czyta. Będzie Ci znacznie łatwiej dokonać zmian bez względu na to czy mówimy
o bloczkach, czy trybie tekstowym.
Ten sam kod, który omawialiśmy przy okazji funkcji, wyglada teraz zupełnie inaczej.
Białe pola przed i po komentarzu to bloczek, który generuje się w miejscu, gdzie w trybie tekstowym został wstawiony znak
nowej linii, czyli enter. Taka forma separatora jeszcze bardziej zwieksza czytelność kodu. Przejdź do kodowania w applab
i sprawdź jak to działa.
ZAPAMIĘTAJ!
Korzystaj z komentarzy mądrze. Mają one za zadanie ułatwić czytanie całego kodu. Jeśli będziesz korzystać z komentarzy zbyt często, sprawią one, że kod stanie się nieczytelny, małoprzejrzysty. Każda skrajność jest zła.
Staraj się pisać krótko i treściwie, tak żeby każdy był w stanie zrozumieć, co Ty jako autor masz na myśli.
To szczególnie ważne na etapie współpracy, by jeden programista rozumiał drugiego nawet bez konieczności rozmowy na temat programu nad którym pracują.
To również ważne dla Ciebie aby po dłuższym czasie kiedy wracasz do starego projektu zrozumieć go po krótkim zastanowieniu.
Role of comments in programming.
When successive lines of code are created during programming, it is useful from
time to time to mark and describe what the a particular piece of code is about. This comes in handy
especially when functions appear. There is a reason for mentioning about functions just here, because
just in this group you will find a block that allows you to insert a comment.
You can only find a single comment in the toolbox. A double one can be created only in text mode.
A more readable code.
When you get into text mode, create some comments, your code will look much better, clearer and will be
very readable and understandable to anyone who reads it. It will be much easier for you to make changes
whether we are talking about blocks or text mode.
The same code that we discussed when we discussed the function now looks completely different.
The white fields before and after the comment are a block that is generated where in text mode the character was inserted
in the new line - just enter. This form of separator further increases the readability of the code. Go to coding in applab
and see how it works.
REMEMBER!
Use comments wisely. They are intended to make the entire code easier to read. If you use comments too often, they will make the code unreadable, low-transparency. Any extreme is bad.
Try to write briefly and succinctly, so that everyone is able to understand what you as the author mean.
It's especially important at the collaboration stage that one programmer understands the other even without having to conversation about the program they are working on.
It is also important for you to, after a long time when you you come back to an old project understand it after a short reflection.