c - 如何记录函数的全局依赖性？

Question

我从使用全局变量(用于速度和空间优化)的第 3 方供应商(用于嵌入式平台)获得了一些 C 代码。我正在记录代码，转换为 Doxygen 格式。

如何在函数文档中注释函数需要全局变量和函数？

Doxygen 具有用于注释参数和返回值的特殊命令，如下所述:Doxygen Special Commands .我没有看到任何全局变量的命令。

示例 C 代码:

    extern unsigned char data_buffer[]; //!< Global variable.

    /*! Returns the next available data byte.
     *  \return Next data byte.
     */
    unsigned char Get_Byte(void)
    {
      static unsigned int index = 0;
      return data_buffer[index++]; //!< Uses global variable.   
    }

在上面的代码中，我想添加 Doxygen 注释，该函数依赖于全局变量 data_buffer。

Answer 1

您可以只为该效果添加注释并使用 \link指令将读者引导至全局变量的描述。