Komentáře v kódu VBA Excelu

Úvodem proč komentovat?

Pokud vytváříte kód je Vám syntaxe a význam příkazu jasný, ale po čase můžete zapomenout. Když se do kódu budete dívat, po roce marně budete pátrat v paměti, co konkrétně tato část kódu provádí, proč je napsána zrovna takto.

Osobní zkušenost: Komentáře jsou neocenitelnou pomůckou pro budoucí úpravy a údržbu kódu. Z vlastní zkušenosti mohu jejich psaní jen doporučit. I když se může zdát, že komentáře obtěžují a zdržují. Není to pravda. Jejich význam oceníte po pár měsících, kdy budete chtít vlastní kód doplnit.

Poznámka: Komentář je nejjednodušší část kódu :), nemůžete v nich udělat chybu (tím nemyslím gramatickou). Pokud řádek správně uvedete, je programu jedno co obsahuje, na druhou stranu kvalitní a použitelný komentář není jednoduchá záležitost.

Ukázka komentáře

Komentář se se označuje "apostrofem" ' . V následujících ukázkách několik řádků komentářů:

Příklad 1

' Můj komentář

Příklad 2

' ------------------------- ' - Můj komentář ' ------------------------

Příklad 3

' ******* Další komentář ************* 123 ******

Komentáře se dají použít i pro optické oddělení kódu. Takže z ukázek je jasné, že psaní komentářů je jednoduché.

Co komentovat?

Doporučuji použít pro popis účelu procedury / funkce / cyklu / ..., který máte v kódu a nejde o úplný základ (komentovat i = i +1 nemá cenu), takže komentáře lze použít u:

• změny - provádíte-li změnu, doporučuji popsat, osobně do komentáře "schovám i původní verzi (ať se mohu vrátit)
• pro nestandartní akce - nedeklarujete-li na začátku Option Base 1, doporučuji u každého pole uvést: Pozor Option Base 1, ať se ví a nezapomene, že počítání je od jedné, ne od nuly jak je standardem.
• konstanty a proměnné - vpvpzopvbpn - název této konstanty je nejasný - ale když do poznámky uvedete, že konstanta se týká: "vyděračský poplatek za tvorbu vlastních programu, zbytečné organizaci plné vyžírků a budižkničemu pod názvem ..." - je jasné, o jakou konstantu jde.
• Goto a jiné divné akce - popište proč je v programu tento skok, třeba za pár měsíců nebude potřeba, až najdete jak to vyřešit elegantněji.
• Nápady na doplnění - pokud Vás napadne, jak se dá kód doplnit či rozšířit, doplňte do komentáře, až bude čas, můžete své kódy dále rozvíjet.

Comment Block / Uncomment Block

Označený blok převedou na komentáře, či z označeného bloku odstraní komentáře.

Ve VBA si můžete zobrazit panel nástrojů Úpravy/Edit takto:

• VBA Excel 2003 (97) - Zobrazit - Panely nástrojů - úpravy.
• VBA Excel 2007 a 2010 - View - Toolbars - Edit

Dvě tlačítka, která Vám dokáží zefektivnit a zpříjemnit práci při programování ve VBA. Do doby než jsem si o nich přečetl, v jednom článku na internetu jsem o nich nevěděl a nepoužíval. Teď bych se bez nich těžko obešel.

Závěrem

Komentujete své kódy přímo do kódu, nebo máte Komentujete své kódy přímo do kódu, nebo máte externí soubor s komentáři a opisem VBA kódu (ať Váš kód konkurence těžko luští)? Předáváte zákazníkům kódy i s komentáři, nebo je uchováváte jen pro vlastní potřebu?

Článek byl aktualizován: 19.09.2020 11:06

Pavel Lasák - autor webu

Microsoft Office (Word, Excel, Google tabulky, PowerPoint) se věnuji od roku 2000 (od dubna roku 2004 na této doméně) - V roce 2017 jsem od Microsoft získal prestižní ocenění MVP (zatím 8x za sebou). Své vědomosti a zkušenosti dávám k dispozici i on-line ve videích pro SEDUO. Ve firmách školím a konzultuji, učím na MUNI. Tento web již tvořím přes 20 let (o Excel píší přes 25). Zdarma je zde přes 1.500 návodu, tipů a triků, včetně přes 350 různých šablon, sešitů a přes 70 taháků v pdf.