package tomp.ucebnice.komentare;

/** Tento program ukazuje možnosti komentování javového programu:
   * tento komentář bude viditelný v dokumentaci API generované nástrojem
   * javadoc.
   * Podle nastavení <tt>javadoc</tt> můžeme vygenerovat jen dokumentaci
   * k veřejně přístupným (<tt>public</tt>) a chráněným (<tt>protected</tt>)
   * třídám a jejim prvkům nebo i k prvkům soukromým (<tt>private</tt>).
   */

public class PouzitiJavadoc2 {
    /*
     Takový komentář příliš nepoužíváme, je dlouhý,
     ale přitom není totiž zachytitelný nástrojem javadoc
     a neobjeví se v generované dokumentaci API.
     */
    public static int cislo = 0; // takto můžeme stručně popsat význam proměnné "cislo"

    /** A takto proměnnou "číslo" popíšeme,
     * aby se popis objevil v dokumentaci API.
     * Hvězičky na začátcích řádků se do dokumentace nepřenesou.
     */
    protected static int číslo = 1;

    /** Toto je korektní javadoc komentář proměnné
     *   "Číslo", který se však v dokumentaci API standardně
     * neobjeví, protože se týká soukromé (private) proměnné.
     * Můžeme jej však zviitelnit volbou <tt>-private</tt> při spouštění
     * nástroje <tt>javadoc</tt>.
     */
    private static int Číslo = 2;

    /**
     Toto komentuje metodu "main".
     Je možné popsat i její parametry (argumenty):
     @param args argumenty zadané při spouštění programu na příkazový řádek
     */
    public static void main(String[] args) {
        System.out.println(cislo);
        System.out.println(číslo);
        System.out.println(Číslo);
    }
}