Doxygen 注释list

最新推荐文章于 2025-10-23 15:09:59 发布

原创最新推荐文章于 2025-10-23 15:09:59 发布 · 529 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#注释list #doxygen

Doxygen 专栏收录该内容

17 篇文章

订阅专栏

博客介绍了列表注释的两种方式。常规方式下，无序列表可用“-”“+”“*”开头，有序列表可用“-#”或数字加“.”开头，列表可嵌套。示例显示数字不连续时仍连续排序，5.1、5.2不能识别。此外还提及了HTML方式。

一常规方式

By putting a number of column-aligned minus (-) signs at the start of a line, a bullet list will automatically be generated. Instead of the minus sign also plus (+) or asterisk (*) can be used.

Numbered lists can also be generated by using a minus followed by a hash or by using a number followed by a dot.

Nesting of lists is allowed and is based on indentation of the items.

即无序列表可以采用“-”、 “+” 、“*” 开头的方式；有序列表可以采用 “-#” 或者 数字+“.” 开头的方式。列表可以嵌套使用。

无序列表：

/** \file list.hpp
 * 
*/

/**
 * @brief demo for list
 *   - key1
 *   - key2
 *      + key21
 *         * key211
 *         * key212
 *      + key22
 *   - key3
 * 
 */
class demo_list{};

有序列表1：

class demo_list1{
/**
 * @brief numbered demo1
 * 
 *  -# o1
 *  -# o2
 *  -# o3
 *    -# 031
 *       -# o311
 *       -# o312
 *    -# 032
 *  -# o4
 * 
 */
  public:int a;
};

有序列表2：

class demo_list2{
  /**
 * @brief numbered demo2
 * 
 *  1. o1
 *  2. o2
 *  5. o3
 *    5.1. 031
 *    5.2. 032
 *  6. o4
 * 
 */
  public:int a;
};

示例中数字没有连续，并且使用了5.1 5.2

结果表明：效果还是连续排序，并且5.1 5.2不能识别（不能识别会当成内容处理）

二 HTML方式

class demo_list3{
  /*! 
   *  A list of events:
   *  <ul>
   *  <li> mouse events
   *     <ol>
   *     <li>mouse move event
   *     <li>mouse click event<br>
   *         More info about the click event.
   *     <li>mouse double click event
   *     </ol>
   *  <li> keyboard events
   *     <ol>     
   *     <li>key down event
   *     <li>key up event
   *     </ol>
   *  </ul>
   *  More text here.
   */
  public:int a;
};

三参考

注释list