Označujte své komentáře, funkce od vývojářů pro vývojáře

Komentáře jsou v životě vývojáře zásadní. Když pracujeme na nové funkci, často přidáváme komentáře, které jsou připomínkou. Například:

• abychom s kolegou ověřili část kódu,
• k refaktorizaci funkce,
• abychom opravili kód, který zpomaluje výkon,
• rozdělit metodu nebo třídu na části,
• připravit kostru třídy a přidat komentář todo uvnitř každé funkce.

I když napíšete nějaký 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 byste si přáli přidat komentáře?

4D v19 R4 posouvá komentáře na zcela novou úroveň díky značkám komentářů, které vám umožní lépe organizovat komentáře.

K dispozici máte tři nové značky:

• MARK
• TODO
• FIXME

V tomto předchozím příspěvku na blogu jsme vám ukázali seznam v editoru kódu, který vám umožní snadnou navigaci v rámci třídy. V tomto seznamu se zobrazují také komentáře, kterým předcházejí tyto tři značky.

Můžete je použít v rámci svých tříd nebo metod.

Jak je používat

Značka MARK vám umožňuje rozdělit kód na části. Můžete jej zapsat třemi různými způsoby. Další dvě značky TODO a FIXME se zapisují stejným způsobem. Jejich výhodou je, že mají v seznamu různé ikony, což vám umožní uspořádat kód tak, abyste si určili priority budoucích činností.

Zde je příklad s třídou ORDA:

Funkce a značky komentářů se zobrazují v pořadí, v jakém se objevují uvnitř třídy a metody. Pokud chcete, můžete zobrazit funkce a značky komentářů třídy v abecedním pořadí tak, že před nasazením nabídky podržíte klávesu Cmd v systému MacOS nebo Alt v systému Windows.

Co bude následovat?

Jste připraveni zintenzivnit svou kódovací hru díky této nové funkci? Řekněte nám, co si o této nové možnosti uspořádání kódu a orientace ve třídách nebo metodách myslíte. Čekáme na vás ve fóru.