Doxygen注释命令

(1) 输出表格

  /**
  * DSTATUS     | value| instruction
  * ------------| ---- | -----------------------
  * STA_NOINIT  | 0x01 | Drive not initialized
  * STA_NODISK  | 0x02 | No medium in the drive
  * STA_PROTECT | 0x04 | Write protected
  */

效果为:
这里写图片描述

(2) 参考其他函数注释:
@see
(3) module name:

/**
  *  @defgroup  test_module_name
  *  @brief     module example.
  */
/**
  *  @ingroup   test_module_name
  *  @brief     source file of module example.
  *  @file      test_module_name.c
  *  @author    test
  *  @version   1.0
  *  @date      2018/2/27
  * /

(4) <b> </b> 以黑体显示字符,用法格式如下:

<b> multiple words </b>

若要黑体显示像标题一样单独一行,可以在后面添加/n,如下图示例所示:
这里写图片描述
生成样式为:
这里写图片描述


(5) to be continued~

猜你喜欢

转载自blog.csdn.net/u010603798/article/details/79315063