Přidání bloku komentářů na začátek metody je užitečné pro přidání poznámky o tom, co metoda dělá, a také seznamu vstupních a výstupních parametrů. A mít několik řádků lidsky čitelného textu uvnitř složitého úseku kódu může být vhodné, abyste si vy i ostatní mohli vzpomenout na účel tohoto konkrétního úseku kódu. Počínaje verzí 4D v18 je vaše programování obohaceno o bloky komentářů!
Komentáře jsou texty (poznámky, popisy, připomínky atd.) ve zdrojovém kódu, označené speciálními znaky, aby je překladač při provádění kódu ignoroval. Komentáře mohou být na jednom řádku komentáře nebo na více řádcích. Nyní můžete místo mnoha řádků s předponou // jednoduše použít /* na začátku komentáře a */ na konci pro okomentování celého bloku. Můžete je také sbalovat a rozbalovat! A to není vše, komentáře můžete přidávat i do libovolné části řádku, dokonce i uvnitř podmínky if nebo cyklu:
Proč jsou komentáře důležité
- V týmu s více vývojáři, kteří pracují na stejném projektu, je dobře okomentovaný kód užitečný pro ostatní, kteří na něm pracují, aby kódu lépe porozuměli a usnadnili si proces kontroly/odladění kódu.
- Jsme jen lidé a zapomínat věci je zcela normální. Pokud si kód později prohlédnete nebo upravíte, komentáře vám pomohou zapamatovat si logiku, kterou jste při psaní daného kódu použili. I když napíšete nějaký opravdu jednoduchý kód, zkuste si ho přečíst o několik měsíců nebo let později. Bude vám stále připadat jednoduchý, nebo si budete přát, abyste přidali komentáře?