[Doxygen Philosopy] 特殊标记符

[Durant35]

• Doxygen的用法，说白了，就是为了解决下面两个问题
  • [ ] 怎么区分普通注释和输出注释
  • [ ] 怎么在输出注释里面，识别特殊标记和普通文本

[Durant35]

区分普通注释和特殊注释

/*
 * 正常注释
 */
/**
 * 要输出成文档的注释
 */
/*!
 * 要输出成文档的注释
 */

// 正常注释
/// 要输出成文档的注释
//! 要输出成文档的注释

通过/或者!作为区分标志

特殊情况：<标志符 指示注释是为前面代码准备的

#define DEV_ON      ((int)(1))      //!< Simple device is power on.
#define DEV_OFF     ((int)(0))      //!< Simple device is power off.

[Durant35]

区分特殊标记符和普通文本

• Doxygen采用 \ 和 @ 作为特殊标记符，当在特殊注释里面检测到了特殊标记符，则接下来检测紧跟单词是不是Doxygen事先规定好的
  • 如果是，则将按照特定的规则来解释紧跟着的注释
  • 如果不是，则将\和@解释为普通文本

    //***************************************************************************************
    //
    //! @brief  Print Int number to terimal device.
    //!
    //! @param  [in] number is the data you want to print.
    //! @retval the number of print information, in bytes. return zero indicate print error !.
    //!
    //! @note
    //! * Be sure you have called \ref Dev_Init function before call this fuction.
    //! * Remember to check return value.
    //
    //***************************************************************************************
    extern int Dev_PrintInt(int number);

Doxygen认识哪些符号呢，参考Doxygen自带手册