Komentare

Kazda trieda musi obsahovat dokumentaciu popisanu pomocou doxygen. Pozor ale na zbytocne pisanie dokumentacie. Napriklad nema vyznam pisat popis atributov funkcie, kde je v popise atributu iba nazov. Interne triedy, ktore nie su sucastou interface su komentovane v sekciach pomocou INTERNAL

/// @cond INTERNAL
/**
 * Internal data holder.
 */
class DataProperty
{
public:
        /// Constructor sets reference counter to zero
        DataProperty();

        /// reference counter (how many times classes references to this shared structure)
        int mRefCount;

        /// command to be exeuted, when accessing property - do not delete in this class!
        Command *mCommand;
};

DataProperty::DataProperty()
{
        mRefCount = 0;
        mCommand = 0;
}

/// @endcond INTERNAL

Dokumentácia

  • pri vytváraní novej funkcionality je potrebné napísať do hlavičkového súboru aj doxygen dokumentáciu v anglickom jazyku
  • podrobnejsie informacie najdete na stranke : http://www.stack.nl/~dimitri/doxygen/commands.html
  • Ukazkovy priklad sluzi len na ilustraciu, poradie sa moze lubovolne menit
   /**
    * @brief strucny popis funkcionality
    * @param popis vstupno-vystupnych parametrov
    * @return popis navratovych hodnot
    * @note poznamka
    * @warning upozornenie na dolezitu funkcionalitu alebo mozny problem
    * @sa link na aktulanu funckiu v danom subore- funkcie sa oddeluju ciarkou
    * @link link na funkciu v inom hlavickovom subore je potrebne zadat Trieda::Funkcia()
    * @list - zobrazenie listu
    *    @li - prvov listu
    *    @li - druhy prvok listu
   */
  
 
coding/rules_k4.txt · Last modified: 2012/06/19 08:27 by 192.168.10.119
 
Recent changes RSS feed Creative Commons License Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki