Kapitola 3. Systémy vývojárskej dokumentácie softvéru

Príklad 3-1. Zdokumentovaný C++ zdrojový kód pre Doxygen

/**
 * Example class
 *
 * More elaborate class description.
 */
class Example
{
	public:

	/**
	 * Example object constructor
	 *
	 * More elaborate description of the constructor.
	 *
	 * @param    bar    a bar constructor parameter
	 * @param    foo    a foo constructor parameter
	 * @return   void
	 */
	Example(int bar = 0, const char *foo = "foo");

	/**
	 * Example object destructor
	 *
	 * More elaborate description of the destructor.
	 */
	~Example();
};

Príklad 3-2. Zdokumentovaný PHP zdrojový kód pre PearDoc

/**
 * Example class
 *
 * More elaborate class description.
 */
class Example
{
	/**
	 * Example object constructor
	 *
	 * More elaborate description of the constructor.
	 *
	 * @param    int      bar   a bar constructor parameter
	 * @param    string   foo   a foo constructor parameter
	 * @return   boolean        true if this example is right,
	 *                          false otherwise
	 */
	function Example($bar = 0, $foo = 'foo')
	{
		// Constructor code goes here. Note that PHP does not
		// have anything like header files with declarations.
		return true;
	}
}

Príklad 3-3. Zdokumentovaný Java zdrojový kód pre JavaDoc

/**
 * Example class
 *
 * More elaborate class description.
 */
class Example
{
	/**
	 * Example object constructor
	 *
	 * More elaborate description of the constructor.
	 *
	 * @param    bar    a bar constructor parameter
	 * @param    foo    a foo constructor parameter
	 * @return   void
	 */
	Example(int bar = 0, const char *foo = "foo")
	{
		// Constructor code goes here
	}
}

Príklad 3-4. Použitie ďalších dokumentačných značiek

/**
 * Extensive Example class
 *
 * This extensive class does some extensive job.
 *
 * @author     Ondrej Jombik <nepto@pobox.sk>
 * @author     Ondrej Holotnak <beast@host.sk>
 * @version    1.2
 * @date       2004-03-26
 */
class Extensive_Example
{
	/**
	 * Normal method doing something
	 *
	 * @param   some    some integer argument
	 * @retval  thing   allocated string filled with thing
	 * @return          test result
	 * @author  Someone External <someone@example.com>
	 * @see     Test()
	 * @see     ~Test()
	 * @todo    make this method something doing
	 */
	int doSomething(int some, char **thing);
};