1

我刚刚将Doxygen添加到我的工具集中，虽然我对大多数技术都很满意，但我对如何记录枚举标志有点困惑（也适用于一般的文档，有或没有 Doxygen） . 给定以下课程：

class foo
{
   /// @enum  Options
   /// @brief Specifies options for the object. Options are combined using
   ///        the bitwise OR operator e.g. "OPTION1 | OPTION2".
   enum Options
   {
   OPTION1 = 1, //< Option 1 description.
   OPTION2 = 2, //< Option 2 description.
   OPTION3 = 4  //< Option 3 description.
   };

   /// @brief Does something.
   /// @param options  Specifies options.
   void bar(int options) {/* Do something */}
};

如何向用户指示如何使用 bar 函数的 options 参数？参数是 int 类型，而不是 Options，因此参数和枚举之间没有直接联系。如果参数是选项类型，那么文档将链接到枚举的描述，这是我想要的行为。

4

2 回答 2

2

所以使参数类型Options。您可以编写返回Options句柄的重载运算符&以及|您需要的任何其他逻辑运算符。

于 2012-11-29T21:42:48.287 回答
1

记录以“指定选项”命名的变量options不是有意义的注释。变量名称已经说明了您现有的评论所说的内容。所以让你的评论有意义：

/// @brief Does something.
/// @param options  Specifies options for the object, which must be a bitwise OR
///                 of zero or more of the bit flags in enum foo::Options.
void bar(int options) {/* Do something */}
于 2012-11-29T22:10:51.770 回答