Macromedia Flash

Výuka Flash (25.)

Úvodem  |  Výuka Flash |  Odkazy  |  Aplikace  |  Otázky a odpovědi

Doporučené postupy

V dnešním díle si povíme něco o doporučených postupech a stylech psaní kódu. Každý vývojář má svůj styl psaní kódu, který mu nikdo nevymluví, ale pokud budeme dodržovat určité schéma, bude se náš kód lépe udržovat a číst i pro ostatní uživatele. V dnešním díle si ukážeme jednotlivé postupy, které vychází z doporučení společnosti Macromedia. Může se stát, že ne každý bude s tímto stylem psaní kódu souhlasit, proto berte tyto styly jako námět.

Způsoby pojmenovávání

Jedním z nejdůležitějších postupů je způsob pojmenování jednotlivých proměnných, konstant, funkcí atd. Jejich názvy by měly tvořit ucelenou formu a vždy bychom měli vědět, co daná proměnná či funkce obsahuje nebo k čemu slouží. Názvy tvoříme většinou z jednotlivých frází, které dostatečně vystihují jejich funkci. Jako příklad si ukážeme jednotlivé jména, jak by mohli vypadat Flashové animace, názvy tříd nebo proměnných:

• jméno klipu - muj_klip.swf
• jméno proměnné nebo vlastnosti - userName
• název třídy - FyzickaOsoba

Názvy funkcí a proměnných mohou začínat malými písmeny. Doporučeno je také stejně jako v příkladě využívat kombinace prvního písmene malého a ostatních velkých. Názvy proměnných mohou obsahovat čísla i podtržítka, avšak nesmějí jimi začínat. Nyní si ukážeme špatné názvy proměnných:

• _promenna - začíná podtržítkem
• 5cisel - začíná číslicí
• muj/test - obsahuje lomítko
• muj test - obsahuje mezeru

Kromě těchto vyjímek nesmějí být jména tvořena také názvy, které využívá ActionScript. Jedná se především o:

• var:String = "foo";
• MovieClip:String = "myMovieClip";
• switch:String = "on";
• case:Boolean = false;
• implements:Number = 5;
• extends = true;

Pro úplný přehled vyhrazených jmen a ostatní zajímavé informace můžete najít v ECMA specifikaci.

Jako další bychom měli zmínit způsob pojmenování konstant. Konstanty je doporučeno psát se všemi písmeny velkými:

• MAXIMUM:Number = 10
• AUTOR:String = "Jméno autora"

I přestože Macromedia Flash MX ActionScript editor obsahuje možnost kompletace kódu, měli bychom psát názvy proměnných ve specifickém formátu, který je tvořen názvem proměnné a jejím typem.

Komentáře

Vždy je doporučeno smysluplně komentovat svůj kód. V případě, že se ke svému kódu vrátíme za nějakou dobu, určitě nám bude připadat cizí. Komentáře by měli plně vystihovat funkci dané proměnné či části kódu, avšak měli bychom se vyvarovat zbytečně podrobným detailům, které jsou již od pohledu jasné. Rozlišujeme dva druhy komentářů.

var cislo:Number = 10 // Identifikační číslo strany.

/* Rozsáhlejší komentář, který se mnohdy uplatní. */

Mezi další způsoby patří také následující informační značky:

// :TODO: - tento komentář využijeme jako poznámku co bychom měli dodělat.

// :BUG: [bugid] topic - tento komentář využijeme jako poznámku, že se vyskytl problém.

// :KLUDGE: - tento komentář využijeme jako poznámku, že zvolená část kódu nesplňuje všechna pravidla a vývojář by si na něj měl dát pozor.

// :TRICKY: - následující komentář využijeme jako poznámku, že na zvolené části kódu závisí i jiný kód, tudíž bychom se měli vyvarovat nebo si dát pozor před přepisováním.

Adresování

Všechny proměnné by měly obsahovat jejich plnou cestu. Měli bychom používat klíčové slova _root, _parent a this. Samotné názvy proměnných by se měly nechávat pouze jako parametry funkcí a lokální proměnné. Jako příklad si ukážeme plnou cestu ke klipu.

this.testovacKlip._alpha = 10;

_root.daliKlip._height = 100;

Závěr

Pro tento díl to bude vše. V příštím díle budeme pokračovat v poznávání Flashe.