doxygen - 如何在 doxygen 中创建 switch case 语句列表？

Question

我需要评论/记录一些现有的代码。为此，我使用 Doxygen，它工作得很好。但现在我有一个问题：我有一个代码，它对命令做出反应，通过用户界面接收。这些命令不在单独的函数中处理，而是在 ONE 函数中使用 switch case 语句进行处理。所以基本上代码如下所示：

switch (command[0])
{
    case 'a': do_something(command[1]);
    case 'b': do_something(command[2]);
    case 'c': do_something_else(command[3]);
    case 'd': do_something_else(command[4]);
}

我想创建某种列表，它提供所有案例的概述，单击案例会导致详细描述。您会为该任务推荐什么 Doxygen 工具？？？？

谢谢....塞巴斯蒂安

标签： doxygen

Answer 1

在记录此 switch 语句的代码时，我会选择以下内容：

/// \file

/// the fie
void fie(void)
{
  switch (command[0])
  {
    /// case a work
    case 'a': do_something(command[1]);
    /// case b work
    case 'b': do_something(command[2]);
    /// case c work
    case 'c': do_something_else(command[3]);
    /// case d work
    case 'd': do_something_else(command[4]);
  }
}

以下也确实有效

/// \file

/// the fie
///
/// depending on the value of `command[0]` the following actions are performed:
/// case a work
/// case b work
/// case c work
/// case d work
void fie(void)
{
  switch (command[0])
  {
    case 'a': do_something(command[1]);
    case 'b': do_something(command[2]);
    case 'c': do_something_else(command[3]);
    case 'd': do_something_else(command[4]);
  }
}

请注意，由于缺少信息，我仅使用 doxygen 1.8.20 进行了测试。