Diskuze: Komentáre v JS OOP

JavaScript JavaScript Komentáre v JS OOP

Avatar
Libor Šimo (libcosenior):

Je nejaká šablóna na komentáre v JS OOP?
Napríklad:

/**
 * class Pohyb zabezpečuje animáciu hráčov, čiar života a označenie víťazstva */
var Pohyb = function(hrac, miestoUtok, miestoObrana, win, live) {
    /**
     * <img id> obrázok hráča (napr. "#zal") */
    this.hrac = hrac;
    /**
     * poloha ukončenia pohybu hráča pri útoku (napr. "230px") */
    this.miestoUtok = miestoUtok;
    /**
     * poloha ukončenia pohybu hráča pri obrane (napr. "0px") */
    this.miestoObrana = miestoObrana;
    /**
     * <p id> Víťazstvo (napr. "#zalW") */
    this.win = win;
    /**
     * <div id> život hráča (napr. "#zivotZal") */
    this.live = live;


    /**
     * animácia hráča pri útoku z pôvodného miesta na nové (miestoUtok)
     */
    this.utok = function() {
              $(this.hrac).animate({left: this.miestoUtok}, 100);
    }
    /**
     * animácia hráča pri obrane z pôvodného miesta na nové (miestoObrana)
     */
    this.obrana = function() {
                var p = $(this.hrac);
                p.fadeOut(50);
                p.fadeIn(50);
                p.fadeOut(50);
                p.fadeIn(50);
                p.fadeOut(50);
                p.fadeIn(50);
                p.fadeOut(50);
                p.fadeIn(50);
                p.animate({left: this.miestoObrana}, 1000);
    }
}

Takto nejak by to mohlo byť?

Odpovědět 17. června 12:13
Aj tisícmíľová cesta musí začať jednoduchým krokom.
Avatar
Taskkill
Redaktor
Avatar
Odpovídá na Libor Šimo (libcosenior)
Taskkill:

Nějak se v tom ztrácím, this.win je typu boolean? Nebo je to element <p>?

Já s tímhle stylem asi nemůžu souhlasit, OOP vzniklo aby zavedlo nějaký odstínění problémů z míst, kde se o nich nemá ani vidět ani slyšet. Tady v tom kódu je vidět přesně to, co by se ti nemělo stávat, když už máš Classu Pohyb, tak ta podle mě nemá držet hráče, ať už je to typově cokoliv, neměla by ani držet nic jako win, healtBar ani většinu z ostatního, to by se mělo odvést jinam, pohybu je jedno, jestli se hráč na obrazovce pohybuje po pixelech, nebo je to autíčko v reálném světě a popojede o 10cm.

Myslím, že na jednoduchou hru by pohyb měla být metoda, přesněji řečeno několik metod typu: krokVpravo(), krokVlevo(), ... atd. Takhle hrozně mícháš věci, který k sobě nepatří. Totiž když si to rozvrhneš dobře, tak pak tu hru můžeš klidně převést na jakýkoliv prostředí, použiješ prostředníka mezi pohybem a skutečným UI controllerem ... typově něco jako:

// nejakej kod a definice class Hrac

krokVpravo = function() {
        UI.controller.moveObject("right", this.id) // this.id tady referuje na identifikator hrace, hrac je technicky vzato objekt v tvem programu, to co je na strane UI je jeho vizualizace, takze to neni ten samy objekt
}
// dalsi kod pro classu Hrac

Je to jen můj pohled na věc, netvrdím, že je nutně správně, ale když budeš chtít tu hru jednou předělat z 2D do 3D a místo nějaký JS knihovny pro 2D grafiku použiješ třeba WebGL, nebo jinou na 3D, jednoduše přepíšeš toho prostředníka, ten objekt UI.controller a je to.

Abych odpověděl na otázku ohledně komentování, já komentuju jen metody, funkce ... správnej kód je sebepopisující, což by mělo platit i pro metody a funkce, ale občas člověk dělá nějaký hacky a tak, takže je to třeba, členské proměnné by měly mít názvy, které by komentování činily zbytečným. Používám vzor:

/**
 *
 * @return
 * @param
 */
 
Nahoru Odpovědět 17. června 12:44
Avatar
Odpovídá na Taskkill
Libor Šimo (libcosenior):

Len skúšam použiť lekcie c# oop v js. :-)

Nahoru Odpovědět 17. června 13:46
Aj tisícmíľová cesta musí začať jednoduchým krokom.
Avatar
Taskkill
Redaktor
Avatar
Odpovídá na Libor Šimo (libcosenior)
Taskkill:

Ale to je v pohodě, JS je plně OOP podporující, od ES6 už dokonce docela nekompromisně. Ale musí se to OOP implementovat skutečně a důsledně, v C# by takhle navržená třída taky byla špatně.
Chci tím jen říct, že tě neodrazuju od OOP v JS, naopak, jen do toho, ale musíš si hlídat co vlastně kam píšeš.

Editováno 17. června 13:51
Akceptované řešení
+20 Zkušeností
+1 bodů
Řešení problému
 
Nahoru Odpovědět 17. června 13:49
Děláme co je v našich silách, aby byly zdejší diskuze co nejkvalitnější. Proto do nich také mohou přispívat pouze registrovaní členové. Pro zapojení do diskuze se přihlas. Pokud ještě nemáš účet, zaregistruj se, je to zdarma.

Zobrazeno 4 zpráv z 4.