doxygen'e başlarken

Kurulum veya Kurulum

Doxygen kurulumu veya kurulumu hakkında ayrıntılı talimatlar.

Kodunuzu yorumlama

Bir yorum bloğunu ayrıntılı bir açıklama olarak işaretlemenin birkaç yolu vardır, böylece bu yorum bloğu Doxygen tarafından ayrıştırılır ve belgelere aşağıdaki kod öğesinin açıklaması olarak eklenir. İlk ve en yaygın olanı, yorum başlatma sırasında fazladan yıldız işareti olan C stili yorumlardır, örneğin:

/**
 * … text …
 */
int dummy_var;

Bir sonraki alternatif, Qt stilini kullanmak ve bir C-stili yorum bloğunun açılış dizisinden sonra bir ünlem işareti (!) eklemektir:

/*!
 * … text …
 */
void foo(void);

Üçüncü bir alternatif, her satırın ek bir eğik çizgi veya ünlem işareti ile başladığı en az iki C++ yorum satırından oluşan bir blok kullanmaktır:

/// 
/// ... text ... 
///

veya

//! 
//! ... text ... 
//!

Bazı insanlar, yorum bloklarını belgelerde daha görünür hale getirmek ister. Bu amaçla aşağıdakileri kullanabilirsiniz:

 /********************************************//** 
  * ... text 
  ***********************************************/

Normal yorum bloğunu sonlandırmak ve özel bir yorum bloğu başlatmak için 2 eğik çizgiye dikkat edin.

/////////////////////////////////////////////////
/// ... text ...
/////////////////////////////////////////////////

Doxygen, oluşturulan belgeleri yapılandırmak ve biçimlendirmek için çok sayıda (> 170) özel komut sağlar. Belgelerdeki tüm komutlar bir ters eğik çizgi () veya bir at işareti (@) ile başlar.

Örneğin

/**
 * \brief    A brief description in one short sentence.
 */

eşdeğerdir

/**
 * @brief    A brief description in one short sentence.
 */

Kısa açıklama için ayrıca birkaç olasılık vardır:

Yukarıdaki yorum bloklarından biriyle \brief komutu kullanılabilir. Bu komut bir paragrafın sonunda biter, bu nedenle ayrıntılı açıklama boş bir satırdan sonra gelir.

/** \brief Brief description. 
 * Brief description continued. 
 * 
 * Detailed description starts here. 
 */ 

Yapılandırma dosyasında “JAVADOC_AUTOBRIEF”, “YES” olarak ayarlanmışsa, JavaDoc stili yorum bloklarının kullanılması, otomatik olarak ilk noktada biten ve ardından bir boşluk veya yeni bir satır gelen kısa bir açıklama başlatacaktır.

/// Brief description which ends at this dot. Details follow 
/// here. 

Ve son olarak, doxygen ile bir işlevin tam belgelenmesi için bir örnek:

/**
 * \brief   The function bar. 
 *
 * \details This function does something which is doing nothing. So this text
 *          is totally senseless and you really do not need to read this,
 *          because this text is basically saying nothing.
 *
 * \note    This text shall only show you, how such a \"note\" section
 *          is looking. There is nothing which really needs your notice,
 *          so you do not really need to read this section.
 *
 * \param[in]     a    Description of parameter a.
 * \param[out]    b    Description of the parameter b.
 * \param[in,out] c    Description of the parameter c.
 *
 * \return        The error return code of the function.
 *
 * \retval        ERR_SUCCESS    The function is successfully executed
 * \retval        ERR_FAILURE    An error occurred
 */

errcode_t bar(int a, int b, int c)
{    
    /** More detailed description inside the code */
}

Doxygen ana sayfasında kaynak ve daha fazla bilgi