我经常看到:
/**************************************************************************//**
* some comments
*****************************************************************************/
为什么不:
/*****************************************************************************
* some comments
*****************************************************************************/
据我了解,doxygen 需要特殊注释来处理它(请参阅:记录代码)。但它也可以选择在 doxyfile 中启用
JAVADOC_BLOCK
。为什么在不需要的时候要牺牲代码的美观呢?
您链接的 doxygen 文档实际上包含答案(显示您提到的确切样式):
- 有些人喜欢让他们的评论块在文档中更加明显。为此,您可以使用以下内容:
/********************************************//** * ... text ***********************************************/
注意:2 个斜杠结束正常注释块并开始 特别评论区。
注意:使用像 clang-format 这样的重新格式化程序时要小心,因为它可能 将此类注释视为 2 个单独的注释并引入间距 他们之间。
所以回答你的问题,它并不是真正需要的,但有些人用它来使他们的评论块在文档中更明显。