×
Vytvárame riešenia

Naming conventions - názvy argumentov funkcií

Okrem tvorby názvov bežných premenných je často potrebné efektívne nazvať aj jednorazové premenné, ktoré slúžia ako argumenty funkcie. Príkladom takýchto premenných sú objekty slúžiace ako nastavenia, ktorých zápis by do volania funkcií tvoril neprehľadný kód.
Príklad: Zápisu objektu do volania funkcie čo vytvára neprehľadný kód.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
$("#dialog").dialog({
buttons : [
{
text : "Button 1",
click : function() {
...
}
},
{
text : "Button 2",
click : function() {
...
}
},
{
text : "Close",
click : function() {
$(this).dialog("close");
}
}
],
modal : true
});
V prípade, ak by obsahovala funkcia viacero argumentov, by bol zápis jej volania ešte viac neprehľadný a nebolo by hneď zjavné, koľko a aké argumenty sa funkcii predávajú. Nasledujúci príklad demonštruje ako sprehľadniť argumenty funkcie.
Príklad: Vytvorenie premennej a použitie ako argumentu funkcie.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
var Settings = {
buttons : [
{
text : "Button 1",
click : function() {
...
}
},
{
text : "Button 2",
click : function() {
...
}
},
{
text : "Close",
click : function() {
$(this).dialog("close");
}
}
],
modal : true
};
$("#dialog").dialog(Settings);
Pre názvy argumentov reprezentujúcich nastavenia je možné použiť nasledujúce názvy.
Príklad: Odporúčené názvy argumentov.
1
2
3
4
Args
Settings
Parameters
Options
V prípade, že nie je použitá konvencia pre objekty (prvé veľké písmeno), môžu uvedené názvy premenných začať malými písmenami (args, settings, parameters, options).
Príklad: Pre uvedený príklad môžu byť použité názvy ako postfixy.
1
2
3
4
DialogArgs
DialogSettings
DialogParameters
DialogOptions
Aj v tomto prípade, ak nie je použitá konvencia pre objekty, názvy premenných môžu začínať malými písmenami (dialogArgs, dialogSettings, dialogParameters, dialogOptions). Z môjho pohľadu by som odporúčal používať premennú s názvom options prípadne settings.

Záver

Efektívny zápis argumentov je jedným z krokov, ktoré prispievajú k sprehľadneniu a rýchlejšiemu pochopeniu celkového programového kódu. V prípade, že používate iné výstižné názvy premenných, podeľte sa o ne prostredníctvom komentára.


Programovanie,JavaScript,argument,funkcia,naming conventions
Žiadna časť tohto článku nesmie byť reprodukovaná bez uvedenia autora a URL na túto stránku.
Viac informácií nájdete v sekcii O projekte.

Komentáre

Článok neobsahuje zatiaľ žiadne komentáre.

Pridať komentár

Meno (povinné)
Web
Správa (povinné)
Odoslať
Od najnovších