Přeskočit na obsah

Doxygen

Z Wikipedie, otevřené encyklopedie

Doxygen je univerzální nástroj pro tvorbu dokumentace ze zdrojového kódu různých programovacích jazyků (C, C++, Java, Python, PHP, ...). Je multiplatformní: lze ho používat pod Unixovými systémy, taktéž i pod Windows a Mac OS X.

Použití

Doxygen generuje dokumentaci z komentářů, umístěných přímo ve zdrojovém kódu projektu. Ty pak musí dodržovat styl Javadoc.

Příklad

/**
  * The time class represents a moment of time.
  *
  * @author John Doe
  */
class Time {
 
   /**
    * Constructor that sets the time to a given value.
    * @param timemillis is a number of milliseconds passed since Jan 1. 1970
    */
   Time(int timemillis) {
   }
 
   /**
    * Get the current time.
    * @return A time object set to the current time.
    */
   static Time now() {
   }
};