Přeskočit navigaci | Přeskočit na novinky
     

Jste zde: Úvodní stránka » excel » vba » komentare-v-kodu-excel-vba

Komentáře v kódu VBA Excelu

Videokurzy Excel

Ve spolupráci se SEDUO jsem vytvořil několik videokurzů:

Informace o komentářích v kódu platí obecně pro VBA (tj. i pro Access, Word, Project)

Ú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.

Tip: Pokud dáváte kód dále a chcete stěžit práci těm, kteří by Váš kód mohli chtít dekódovat, mějte kódy dva, jeden s komentáři a druhý bez.

Osobně "své" (své - není úplně přesný název, mnohdy se nechávám inspirovat kódy na internetu, jako koneckonců většina programátoru) kódy dávám k dispozici i s komentáři.

Tip 2 : Komentáře se snažte psát již během psaní a testování procedur a funkcí. Jakmile vše bude fungovat, už se Vám do toho nebude chtít, a navíc na to nebude čas.

Comment Block / Uncomment Block

Super pomůcka při práci s komentáři - Comment Block = Blok do komentáře a Uncomment Block Commands = Blok z komentáře

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
MS Excel VBA - Comment Block / Uncomment  Block

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: 01.11.2014 13:50

Odměna

Ušetřil vám tento web čas, peníze? Pomohl vyřešit problém? Jste ochotni poskytnout symbolickou odměnu na další rozvoj? Vybrte si formu odměny, která vám vyhovuje.


Pavel Lasák - autor webu

Pavel Lasák

Microsoft Office (Word, Excel, PowerPoint) se věnuji od roku 2000 (od 2004 ne této doméně) - Roku 2017 jsem od Microsoft získal prestižní ocenění MVP (zatím jsem jediný z ČR v kategorií Excel). Své vědomosti a zkušenosti dávám k dispozici také na on-line videích pro SEDUO. Školím a konzultuji, učím na MUNI. Hlavně tvořím tento web. Je zde k dispozici přes 1.000 návodu, tipů a triků včetně stovek různých šablon, sešitů.

   Pavel Lasák LinkedIn Profil    Pavel Lasák Google+ Profil    Pavel Lasák facebook Profil    Pavel Lasák twitter Profil


Komentáře zatím nejsou

Můžete být prvními co zanechají smysluplný komentář.







Sdílejte

Pomohl Vám návod?
Sdílejte na Facebooku, G+
LinkedIn...

Nové články


Newsletter

Přihlaste se odběru novinek a získejte:
Ebook zdarma -
10 kroků ke zvládnutí (Word, Excel, PowerPoint)
Šipka Kniha 3D Více o ebooku ...

TOPlist Licence Creative Commons webarchiv rss XML

Stránky o MS Office (Excel) produktu společnosti Microsoft. Neslouží jako technická podpora.
| Email na autora: pavel.lasak@gmail.com | Copyright © : Pavel Lasák 2004 - 2017 | 18334

Tento web zatím neprošel jazykovou korekturou. Beta verze redakčního systému.