Question

我是Doxygen的新手，但我想我知道如何写评论。我现在有一些散漫的抱怨，抱怨以下警告中的“警告：注释块中意外的令牌，同时解析命令参数的参数”，抱怨@brief行。

/**
  * @brief  Converts ADC reading to battery voltage
  * @param  adcVal raw ADC reading
  * @retval Battery voltage as float
  * @note   Assumes 12 bit ADC and 3.3 volt VCC
  * @note   Broken out for testability
  */

有人可以告诉我什么是意外令牌吗？我什至采取了重新输入注释框的方式，以为我在那里有一个看不见的角色。（以前发生过...）。

我在Doxygen文档中没有发现任何提及错误消息的信息。

当然我认为我今天特别笨拙……

Answer 1

弄清楚了。我很懒，我在周围保留了一个空的Doxygen注释块，可以在添加新功能时进行复制和粘贴：

/**
    *   @brief
    *   @param
    *   @param
    *   @param
    *   @retval
    *   @note
    */

好吧（无论如何，根据经验），事实证明，如果之后有 real 注释块，请说：

/**
  * @brief this is a dummy function
  * @param x is the input argument
  */

Doxygen感到困惑。约翰感到困惑。

所以，我是小学生，但我发现了问题。

为什么我在Doxygen中收到“意外令牌”错误？

1 个答案: