C++ Comment

1. File

• Required (in order)

  • file
  • brief
  • author

• Example

// my_class.h

/**
 * @file  my_class.h
 * @brief  file_brief
 * @warning warning
 * @note note
 * @todo todo
 * @bug  bug
 * @deprecated deprecated
 * @code{.cpp}
 * int x = -1;
 * @endcode
 * @invariant invariant
 * @pre  pre
 * @post post
 * @remark remark
 * @author  gendloop
 */

2. Class

• Required (in order)

  • brief
  • author

• Example

/**
 * @brief brief
 * @author author
 */

3. Func

• Required (in order)
  • brief
  • param
  • author

/**
 * @brief   brief
 * @param[in]  var var_brief
 * @param[out]  var var_brief
 * @return  int
 * @todo  sth. is todo
 * @bug   a bug
 * @deprecated deprecated
 * @author  gendloop
 */

4. Var

• Required (in order)

  • /

• Example

/**
 * @brief var_brief
 * @note var_note
 */

///< var_brief

5. References

1. https://www.doxygen.nl/manual/docblocks.html Doxygen Manual_ Documenting the code.html