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

Question

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

我在偏好设置＆gt;中将“文档工具评论工作区默认设置”设置为“Doxygen” C / C ++＆gt;编辑器。

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

Answer 1

在写入时，在鼠标悬停时显示Doxygen注释：

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

Answer 2

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

如果您正在使用外部构建系统（make / cmake eg。），其中eclipse无法传递它的宏定义，那么您需要做的就是将实现放在其中＆＃39 ; s拥有include guard并将include guards macro添加到eclipse的符号定义中。这将隐藏eclipse中的那部分代码，迫使它使用预期的注释而不影响构建。

例如：

#ifndef INCLUDE_GUARD_FOR_IMPLEMENTATION
#define INCLUDE_GUARD_FOR_IMPLEMENTATION

// Implementation code

#endif

然后在项目中 - ＆gt;属性 - ＆gt; C / C ++一般 - ＆gt;路径和符号在符号部分下添加INCLUDE_GUARD_FOR_IMPLEMENTATION。

它当然会产生使该部分变灰的副作用，如果您不能或不想将实现代码放在单独的标题中，它可能看起来不合适。 / p>