Eclipse悬停提示可以显示头文件中的Doxygen注释吗

Question

我正在使用Eclipse CDT编写C++代码。在阅读了StackOverflow上关于是将doxygen文档放在头文件中还是实现文件中的几篇讨论后，似乎大多数开发人员都赞成将doxygencomments放在头文档中（当然，这绝非共识）。但是，如果我把doxygen注释放在头文件中，当我把鼠标指针悬停在有注释的方法/成员的实例上时，我就无法让Eclipse显示这些注释。有没有一种方法可以让Eclipse利用Eclipse悬停提示中的头文件中的Doxygen文档？

我在"首选项">"C/C++">"编辑器"中将"Documentation tool comments Workspace default"设置为"Doxygen"。

我在Ubuntu 11.04上使用Eclipse 3.6.2和CDT 7.0.2。

Answer 1

Doxygen注释在写时悬停在Eclipse中：

• 方法源之前的cpp文件（或标头）文件（不是声明）
• 类声明之前的头文件

Answer 2

我找到了解决这个问题的方法，但对于一般使用来说非常不方便。

如果您使用的是eclipse无法传递其宏定义的外部构建系统（例如make/cmake），那么您所需要做的就是将实现放在自己的include-guard中，并将include-guards宏添加到eclipse的符号定义中。这将对eclipse隐藏该部分代码，迫使它在不影响构建的情况下使用预期的注释。

例如：

#ifndef INCLUDE_GUARD_FOR_IMPLEMENTATION
#define INCLUDE_GUARD_FOR_IMPLEMENTATION
// Implementation code
#endif

然后在项目->属性->C/C++常规->路径和符号中，在符号部分下添加INCLUDE_GUARD_FOR_IMPLEMENTATION。

当然，它确实有灰显部分的副作用，如果你不能或不想把实现代码放在一个单独的头中，它可能看起来很不合适。