Užitečné komponenty pro Delphi a C++ Builder, díl 57.

Delphi Formatter

Psát dobře zdrojový kód, to neznamená jen jeho funkčnost. Ta se předpokládá jako samozřejmost, protože je to cíl naší práce. Dobrý zdrojový kód musí ale být též snadno čitelný a pokud možno i dobře okomentovaný. Naučit se správný styl psaní nebo si na nějaký zvyknout je otázka času a praxe a v tom vám žádný program nepomůže. V čem vám však program může pomoci je úprava již napsaného zdrojového kódu tak, aby vypadal profesionálně, byl dobře čitelný a odpovídal běžným zvyklostem. Právě to umí Delphi Formatter.

Tento produkt může pracovat ve dvou režimech - buď jako samostatná aplikace (tu jsem testoval já) a nebo jako expert přímo v Delphi IDE. Funkčnost je zcela totožná, takže si můžete vybrat. Po spuštění aplikace se vám objeví okno, které na první pohled připomíná běžný a velmi jednoduchý textový editor. Hlavní menu obsahuje funkce programu, malý panel nástrojů s několika ikonami umožňuje vybírat ty nejčastější činnosti a většinu obrazovky pak zabírá okno samotného editoru. Ten používá metodu záložek, takže můžete mít otevřenu řadu souborů současně a snadno mezi nimi přepínat.

Nejprve tedy načteme zdrojový kód a to buď jako samostatný unit ve formátu .pas a nebo můžeme načíst rovnou celý projekt, kdy se nám otevřou všechny jednotky, které obsahuje. Načtený zdrojový kód pak můžete v editoru přímo i upravovat, i když to není jeho primární funkcí. Editor obsahuje jednoduché zvýrazňování syntaxe, které je nebarevné, takže pouze tučně zvýrazňuje klíčová slova. To však úplně stačí vzhledem k zaměření programu. Když máme tedy zdrojové kódy připraveny, je čas podívat se do nastavení programu, kde si nadefinujeme parametry formátování.

Nastavení je opravdu celá řada a na celkem 6 záložkách (plus záložka s náhledem, viz. dále) se můžete opravu vyřádit. Program je po spuštění defaultně nastaven tak, jaký zápis syntaxe používá samotný Borland. Názorů na správné psaní zdrojového kódu je však celá řada a na webu existuje několik protichůdných táborů, které se snaží prosadit vlastní styl. Nastavit si tak můžete proto opravdu téměř vše.

Na první záložce si můžete zvolit odsazení jednotlivých "podřízených" řádků, které je defaultně nastaveno na dvě mezery. Dále si můžete zapnout extra odsazení (navíc k tomu běžnému) u klíčových slov jako je begin, try, else apod.. Odsadit si můžete i komentáře či direktivy.

Druhá záložka skrývá nastavení mezer. Můžete si definovat například to, že před i za každým matematickým operátorem či příkazem přiřazení bude mezera (tak jak je to obvykle zvykem). Nastavit si můžete, zda se má mezera doplnit jen před nebo jen za příslušný element či po obou stranách.

Záložka Line breaks již svým názvem napovídá, co skrývá. Několika zatržítky si můžete nastavit vkládání konců řádků pro rozličné situace. Na záložce Capitalization zase naleznete nastavení, které se týká psaní klíčových slov velkými písmeny.

Předposlední záložka Align se týká zarovnání komentářů a konstant a na záložce Misc si můžete nadefinovat vlastní direktivu a kód, který bude touto direktivou ohraničen, pak bude při formátování přeskočen. Na poslední záložce Preview si můžete zkusit napsat pár řádků kódu. Ať už jej napíšete jakkoliv hnusně, v náhledovém okně uvidíte, jak bude výsledný kód vypadat po naformátování danými nastavenými pravidly.

A to je vše. Teď je čas zavřít okno s nastavením, kliknout na tlačítko Format a otevřený zdrojový kód nebo všechny se vám v mžiku přeformátují.

Co říci závěrem? Jedná se o velmi šikovný nástroj, který je jednoduchý na používání a přitom velice funkční. K úplné dokonalosti mi ještě chyběla možnost ukládat definice jednotlivých stylů formátování do souborů a pak mezi nimi přepínat. A rovněž export zformátovaného textu do HTML by byl určitě užitečný. Toho se ale třeba dočkáme v některé z příštích verzí.