Zobrazení zdroje stránky Konvence pro skriptovací jazyk

Tento dokument popisuje konvence skriptovacího jazyka
== Deklarace externích funkcí ==
{|
|-
*Bez odsazení 
*Mezery před a za názvem knihovny
*Deklarace nezalamujeme
*Za blokem deklarací vynecháme jeden řádek
<pre style="background-color: rgb(255, 153, 153);">
declare function GetCurrency dll"ActualDocument"(string): currency // Špatně
</pre>
<pre style="background-color: rgb(153, 255, 153);">
declare function GetCurrency dll "ActualDocument" (string): currency // OK
</pre>
|}

== Název skriptu ==
{|
|-
*Bez odsazení
*Bez mezer kolem <code>()</code>
*Název začíná velkým písmenem, ostatní písmena jsou malá, s výjimkou počátečních písmen dalších slov
*Standardně pojmenování v angličtině, pokud ale jsou historicky skripty v upravovaném workflow pojmenovány česky, můžeme při úpravách pojmenovávat nadále v češtině
<pre style="background-color: rgb(255, 153, 153);">
script Get_currency_code(): string // Špatně
script GetCurrencyCode () : string // Špatně
</pre>
<pre style="background-color: rgb(153, 255, 153);">
script GetCurrencyCode(): string // OK
</pre>
|}

== Klíčová slova ==
{|
|-
*Klíčová slova (zvýrazněná v editoru), např. názvy typů, píšeme '''vždy''' malými písmeny
*Pozor na klíčové slovo <code>nounload</code>, které se nezvýrazňuje
<pre style="background-color: rgb(255, 153, 153);">
String, Integer, ActualDocument, Result // Špatně
</pre>
<pre style="background-color: rgb(153, 255, 153);">
string, integer, actualdocument, result // OK
</pre>
|}

== Lokální proměnné ==
{|
|-
*Deklarace první proměnné je vždy pod klíčovým slovem <code>var</code>, nikdy ne na stejné řádce
*Odsazení 2 mezery
*Na stejné řádce vždy pouze úzce související proměnné (např. souřadnice <code>X</code>, <code>Y</code>)
*Mezera za znaky <code>,</code>, resp. <code>:</code>, nikdy ne před těmito znaky
*Proměnné pojmenováváme vždy popisnými jmény, nepojmenováváme pouze jedním písmenem (výjimkou mohou být např. souřadnice <code>X</code>, <code>Y</code>, řídící proměnné cyklů <code>I</code>, <code>J</code> atpod.)
*Proměnné pojmenováváme malými písmeny, pouze počáteční písmena slov jsou velká (platí i pro globální proměnné)
*V názvech nepoužíváme podtržítka (platí i pro globální proměnné)
*Pro proměnné, které mají neočekávaný typ, používáme prefixy psané malými písmeny
{| class="wikitable"
! Typ
! Prefix
|-
| <code>string</code>
| style="text-align: center;"| s
|-
| <code>integer</code>
| style="text-align: center;"| i
|-
| <code>boolean</code>
| style="text-align: center;"| b
|-
| <code>date</code>
| style="text-align: center;"| d
|-
| <code>currency</code>
| style="text-align: center;"| c
|-
| <code>user</code>
| style="text-align: center;"| u
|-
| <code>usercollection</code>
| style="text-align: center;"| uc
|}
*Nepoužíváme lokální listové proměnné (<code>stringlist</code>, <code>integerlist</code>, …), protože nefungují správně
<pre style="background-color: rgb(255, 153, 153);">
var Count: integer // Špatné odsazení, schází zalomení
  S_Count: string // Špatné pojmenování proměnné
</pre>
<pre style="background-color: rgb(153, 255, 153);">
var
  Count: integer // OK
  sCount: string // OK
</pre>
|}

=== Lokální konstanty ===
{|
|-
*Konstanty zapisujeme do sekce <code>var</code>, protože sekci pro konstanty skriptovací jazyk nepodporuje
*Konstanty v sekci zapisujeme před proměnné a mezi konstantami a proměnnými vždy vynecháme prázdný řádek
*Konstanty pro odlišení pojmenováváme pouze velkými písmeny, pro oddělení slov používáme podtržítko
*Je vhodné pro přehlednost všechny konstanty nadefinovat hned na začátku skriptu
<pre style="background-color: rgb(255, 153, 153);">
var
  ItemCount: integer // Špatné pojmenování konstanty, označuje proměnnou
</pre>
<pre style="background-color: rgb(153, 255, 153);">
var
  ITEM_COUNT: integer // OK
</pre>
|}

== Tok skriptu ==
{|
|-
*Odsazení na 2 mezery
*Maximální délka řádku 80 znaků
**Tolerovat lze nezalomení do 100 znaků
*Při zalomení řádku je na dalším řádku (řádcích) odsazení 4 mezery
*Zalamování je vhodné za oddělovači (<code>, :</code>), binárními operátory (<code>+ - * / = := += -= ++= or and, ...</code>) nebo za <code>( [</code>
<pre style="background-color: rgb(255, 153, 153);">
// Špatně
I := 0 J := 0

if I > 0 then J += 1 end
</pre>
<pre style="background-color: rgb(153, 255, 153);">
// OK
I := 0
J := 0

if I > 0 then
  J += 1
end
</pre>
|}

== Komentáře ==
{|
|-
*Komentáře se zarovnávají stejně jako kód skriptu
*Za uvozením komentáře vložíme mezeru a začneme velkým písmenem
*U víceřádkového komentáře nepoužíváme <code>//</code> a komentář zarovnáme do bloku
<pre style="background-color: rgb(255, 153, 153);">
//špatně
/* Také
špatně */
</pre>
<pre style="background-color: rgb(153, 255, 153);">
// Toto je správně
/* Také
   správně */
</pre>
|}

== Výrazy ==
{|
|-
*Vkládáme jednu mezeru před i za operátor
*Nevkládáme zbytečné závorky
**Výjimkou jsou logické výrazy obsahující více podmínek, kde zápis bez závorek ztrácí na přehlednosti
<pre style="background-color: rgb(255, 153, 153);">
// Špatně
I:=J+5
if (I = 0) then
if I = 0 and J = 0 then
</pre>
<pre style="background-color: rgb(153, 255, 153);">
// OK
I := J + 5
if I = 0 then
if (I = 0) and (J = 0) then
</pre>
|}

== Ukončení příkazů ==
{|
|-
*Koncový <code>end</code> je vždy zarovnán stejně jako příkaz, ke kterému se váže
*Blok kódu pod tento příkaz spadající je oproti příkazu odsazen o 2 mezery
<pre style="background-color: rgb(255, 153, 153);">
// Špatně
if I = 0 then I += 1 end 
</pre>
<pre style="background-color: rgb(153, 255, 153);">
// OK
if I = 0 then
  I += 1
end
</pre>
|}

== Příkazy ==
=== Příkaz if (else) ===
{|
|-
*Blok kódu pod tento příkaz spadající je oproti příkazu odsazen o 2 znaky
*Pokud je testována jedna proměnná na více hodnot, používáme pro přehlednost i zvýšení výkonu <code>else</code> větev
**Toto neplatí, pokud se řídící proměnná podmínky může změnit v kódu spadajícím pod předchozí podmínku
<pre style="background-color: rgb(255, 153, 153);">
if I < 0 then
  write("Záporné číslo")
end
if I = 0 then
  write("Nula")
end
if I > 0 then
  write("Kladné číslo")
end
</pre>
<pre style="background-color: rgb(153, 255, 153);">
if I < 0 then
  write("Záporné číslo")
else
  if I = 0 then
    write("Nula")
  else
    write("Kladné číslo")
  end
end
</pre>
|}

=== Příkaz case ===
{|
|-
*<span style="color: red;">Protože příkaz <code>case</code> '''nefunguje správně''', je nutné použít sadu podmínek <code>if</code> !!!</span>
*Pokud je velké množství porovnávaných hodnot a docházelo by k velkému zanoření kódu kvůli cyklickému odsazení <code>else</code> větví, je možné použít cyklus <code>while true do</code> se sadou podmínek, kdy každá obsahuje příkaz <code>break</code> pro ukončení cyklu a ukončení porovnávání hodnot
**Pokud bude zapomenut příkaz break, skončí skript v nekonečné smyčce
<pre style="background-color: rgb(153, 255, 153);">
while true do
  if I = 0 then
    write("Nula")
    break
  end
  
  if I = 1 then
    write("Jedna")
    break
  end
  
  if I = 2 then
    write("Dva")
    break
  end
  
  // Else větev
  write("Neznámé číslo")
  break
end
</pre>
|}

=== Cykly while do, for to do, foreach do ===
{|
|-
*Pokud známe potřebný výsledek před dokončením všech obrátek cyklu, vždy jej předčasně ukončíme příkazem <code>break</code>
*Pokud před dokončením jednoho průchodu cyklem víme, že nemůžeme získat potřebný výsledek, pokročíme rovnou na další index pomocí příkazu <code>continue</code>
|}