Malý trik s komentáři

Většina programátorů následující malý trik v nějaké variantě asi zná, protože se o něm píše v každé druhé knížce o programování, ale pokud přeci ne, tady je:

Pokud pracujete na nějakém programu a neustále v něm zakomentováváte a odkomentováváte některou pasáž (třeba ladící verzi definic maker), jistě vás po chvíli začne štvát neustálé popojíždění na začátek a konec zakomentovávaného bloku a vepisování komentářových značek.

Tomu se dá hezky zabránit tím, že na začátek bloku přidáte znaky "// /*" a na konec "// */". Zakomentování a odkomentování se pak provede umáznutím resp. opětovným připsáním dvou lomítek na začátku – žádné popojíždění se nekoná.

Zakomentováno:

/*
.
.
.
kód
.
.
.
// */

Odkomentováno:

// /*
.
.
.
kód
.
.
.
// */

Mechanismus fungování tohoto triku tu snad vysvětlovat nemusím. Je taky doufám zřejmé, že takhle přesně to funguje jen v C-like jazycích a v těch ostatních je nutné trik trochu poupravit. Ale to už snad každý zvládne.

Většina věci znalých čtenářů se možná bude podivovat, proč vůbec na začátek bloku v odkomentovaném stavu psát znaky "// /*", které nejsou vůbec potřeba. Dle mé skromné zkušenosti je to výhodné jako "optický poutač" – snadno se pak vidí, kde zakomentovávaný blok začíná, a to zmenšuje pravděpodobnost, že při zakomentování značku počátku komentáře omylem umístíte o pár řádků vedle.

Jul 24, 2004 – 20:18