VB - 23. lekce

23.1 Pojmenování proměnných, konstant a funkcí
23.2 Proč a jak využívat konstanty
23.3 Další pravidla
23.4 Řetězce s předdefinovanou délkou
23.5 Unipolární mínus
23.6 Domácí úkol
23.7 V další lekci

23.1 Pojmenování proměnných, konstant a funkcí.

Dnes se podíváme na to, jaká se na psaní kódu vztahují pravidla. Někomu se to možná zdá nudné, nezáživné nebo tak. Já naopak si myslím, že je to docela zajímavé a hlavně důležité, neboť to nemalou měrou napomáhá k přehlednosti kódu.

Pojmenování Proměnných

Proměnné se pojmenovávají podle konvence camel. Camel znamená velbloud proč právě on? Protože název proměnné by se měl skládat minimálně ze dvou slov. První by mělo označovat datový typ proměnné a druhé její funkci či obsah. První začíná malým písmenem druhé slovo už začíná písmenem velkým. Proto velbloud, vytvoří se totiž takové hrby. Z názvu by také mělo vyplývat, co proměnná obsahuje nebo k čemu slouží. A měly by být anglicky, aby tomu rozuměli zahraniční kolegové.

Dim lngCounter as Integer
Dim lngDownLimit as Integer
Dim lngDolniMez as Integer 'není vhodné kvůli češtině

Pokud přesto chcete používat češtinu tak používejte cestinu bez hacku a carek.

Pojmenování konstant

Pro konstanty se používá zase jiná konvence. Konvence UCase čili velká písmena. Z názvu by opět mělo vyplývat, co konstanta obsahuje. Slova se dělí podtržítkem.

Const FIRST_SERIAL_NUMBER as Long = 2569
Const MAXIMAL_VALUE as Long = 300
Const DOWN_LIMIT as Long = 6
Const PI as Long = 3.141592654

Opět se vyvarujte češtiny.

Pojmenování Funkcí a Procedur

Zde se uplatňuje opět jiná konvence a to konvence Pascal. Ta je podobná kovenci Camel ale první písmeno je zde velké. Názvy by měly (mám nutkání napsat musí ale bohužel nemusí) obsahovat to, co procedura dělá nebo to , jakou hodnotu funkce vrací.

Function x(Optional ByRef d As Long) As Boolean

End Function 'Naprosto nevhodné pojmenování


Function GetValue(Base As Long) As Boolean

End Function 'Vhodné pojmenování


Sub PrintText(Text As String)

End Sub ' Vhodné pojmenování

Tím bych tuto kapitolku uzavřel a jedeme dále.

23.2 Proč a jak využívat konstanty

Konstanty ano či ne. Tak zde mám jednoznačnou odpověď: ano! Jejich použití je pohodlné, zvyšuje čitelnost kódu a pokud potřebujete hodnotu změnit, měníte ji jen na jednom místě a ne v každém kousku kódu. Proto jejich použití mohu jen doporučit. I u zdánlivých triviálností je lepší obrátit se na konstantu, než práskat do kódu jen tak čísla. Ale na druhou stranu všeho s mírou. U některých projektů lze bez problému najít i stovky konstant.

23.3 Další pravidla

Z názvu funkce by měl být čitelný datový typ navrácené hodnoty.

GetName()

Snažte se používat málo zkratek v názvech funkcí, konstant a proměnných. Toto pravidlo je sporné a nedá se aplikovat vždy. Někdy je využití zkratek naopak výhodou a nejlepším řešením. Kdy - to je na vašem zdravém úsudku.

Dále je záhodno používat doplňkové výrazy k párovým či hromadným proměnným. Např.: Max, Min nebo DownLimit a UpLimit.

Snažte se název doplnit údaji, které o proměnné řeknou co nejvíce.

Proměnné i, f, x, čili proměnné skládající se z jednoho znaku používejte jen v čítačích.

I pro proměnné, které se v programu vyskytují málokrát, třeba jen dvakrát, používejte smysluplný název. Místo lpfj.

Snažte se psát tak, aby váš kód pochopil i člověk ne příliš obdařený inteligencí: Jednoznačné názvy funkcí, proměnných i konstant, které mají vysokou výpovědní hodnotu.

Na druhou stranu, není vhodné psát proměnné, které zaberou půl sta znaků. Čili všeho s mírou.

Nezapomínejte, že máte tabulátor a že ten kód po vás možná bude někdo číst.

23.4 Řetězce s předdefinovanou délkou

Řetězce s předdefinovanou délkou se využívají například v některých API funkcích. Deklarují se takto:

Dim Jmeno As String * 50

V paměti se tak pro řetězec alokuje adekvátní prostor.

23.5 Unipolární mínus

Pomocí unipolárního mínusu se převrací hodnota čísla či proměnné.

b = 7 'do b dáme hodnotu 7
b = -b 'hodnotu změníme na -7
Print b 'vytiskneme hodnotu -7
Print -b 'vytiskneme hodnotu 7

23.6 Domácí úkol

Učit se, učit se, cvičit a procvičovat, zkoušet a testovat, tvořit a psát, neboť právě to je klíčem k ůspěchu.

23.7 V další lekci

V další kapitole si ještě trochu více prohlédneme rozhodovací strukturu Case Select a nejen to.