english version while1 - stránky o programování

Komentář

Popis

Komentáře nemají žádný význam pro provádění programu (při překladu jsou nejčastěji nahrazeny jednou mezerou). Mohou se vyskytovat všude tam kde lze zapsat mezeru. Slouží jako poznámky k obtížnějším částem zdrojového kódu nebo k zdůraznění důležitých míst. Nadbytečné poznámky nebo poznámky na nesprávných místech naopak čitelnost kódu ještě zhoršují.

Význam komentářů umocňují nástroje automatického generování programové dokumentace (JavaDoc, Doxygen, ..).

Vývojový diagram

Přirozený jazyk

JSA

Komentáře do konce řádku začínající znakem ;středník.

Pascal

Z důvodu přenositelnosti zdrojového kódu se doporučuje použití víceřádkového komentáře {poznamka} ze standartního Pascalu. Druhou možností je víceřádkový komentář (* poznamka *) s nevýhodou dvouznakového začátku a konce. Ve FreePascalu lze zapsat i komentář do konce řádku začínající //, jehož použitím vytvoříte zdrojový kód nepřenositelný pro jiné (starší) překladače (TurboPascal, BorlandPascal).

C/C++

C++

Zápis komentářů je totožný s jazykem BCPL, předchůdcem jazyka C a tím i C++. Jedním způsobem je víceřádkový komentář /* poznamka */ a druhým komentář do konce řádku začínající //.

C

Původní norma jazyka C povoluje pouze víceřádkový komentář /* poznamka */. Komentář do konce řádku // je možné použít až od normy C99.

Doxygen

Doxygen je nástroj pro automatické generování programové dokumentace v některém z formátů: html, pdf, tex, man, rtf, xml nebo ps. Zdrojový kód je pro zpracování doxygenem nutné upravit: jenom víceřádkový doxy komentář /*! poznamka **/ a doxy komentář do konce řádku //! budou zahrnuty do vygenerované dokumentace.

Programovou dokumentaci lze Doxygenem vygenerovat z projektu klient/server (pro přenos souborů). Archiv obsahuje okomentované zdrojové texty (adresář src) a výslednou dokumentaci (adresář html).

Speciální značky:

  • \brief - stručný popis
  • \param - parametry
  • \return - návratová hodnota
  • \see - odkaz
  • \author - jmeno autora (na zacatku souboru)

Java

Syntaxe (zápis) programu vychází z jazyka C++. Je možné použít víceřádkový /* poznamka */ nebo jednořádkový komentář do konce řádku začínající //poznamka.

JavaDoc

JavaDoc je nástroj pro automatické generování programové dokumentace ve formátu html. JavaDoc komentáře se zapisují uvnitř /** poznamka */.

Speciální značky:

  • @param - parametry
  • @return - návratová hodnota
  • @see - odkaz
  • @author - jmeno autora (na zacatku souboru)


okomentovaná třída[ Kniha.java ]
/*
 * Kniha.java
 *
 * Vytvoreno  6. červenec 2005, 10:19
 */

package type;

/**
 *  Trida Kniha.
 *  @author Vaclav Bubnik
 */
public class Kniha {
 //atributy:  
    /** jmeno knihy */
    public String jmeno;
    /** cena knihy */
    public int    cena;
    /** autor knihy */
    public String autor;
    
 //metody:    
    /** konstruktor */
    public Kniha() {
        System.out.println("konstruktor Kniha()");                
        // nastaveni vychozich hodnot volanim metody zadej()
        zadej("nezadano", 0, "nezadano"); 
    }    
    
    /** vyplneni informaci o knize
     *  @param jm jmeno knihy
     *  @param c cena knihy
     *  @param au autor knihy
     */
    public void zadej(String jm, int c, String au) {
        jmeno = jm;
        cena  = c;
        autor = au;
    }    
    
    /** vypis informaci o knize */
    public void vypis() {
        System.out.println("vypis()");        
        System.out.println(" jmeno : " + jmeno);
        System.out.println(" cena  : " + cena);
        System.out.println(" autor : " + autor);
    }    
    
    /** zjisteni ceny knihy
     *  @return cena knihy
     */
    public int cena() {
        System.out.println("cena()");        
        return cena;
    }        
}

JavaScript

Syntaxe (zápis) programu vychází z jazyka C++. Je možné použít víceřádkový /* poznamka */ nebo jednořádkový komentář do konce řádku začínající //poznamka.

Matlab

  • %komentář do konce řádku
  • %{ komentář přes několik %{ lze zanořovat %} řádků %}
  • ... komentář do konce řádku ve víceřádkové definici

PHP

Syntaxe (zápis) programu vychází z jazyka C++. Je možné použít víceřádkový /* poznamka */ nebo jednořádkový komentář do konce řádku začínající //poznamka.

Cvičení

  1. Napište program v libovolném programovacím jazyku, který ze souboru se zdrojovým textem tohoto jazyka odstraní všechny komentáře a nahradí je jednou mezerou. Pozor na uvozovací znaky komentářů uvnitř řetězcových literálů. (řešení v C)

Kontakt
Prohlášení o dostupnosti
Tisk stránky
Autor: Václav Bubník © 2005
vbubnik@post.cz
XHTML 1.0| CSS