11

我在 C++ 上编程时使用 Eclipse Indigo。我正在使用提供大量 doxygen 注释的代码。我希望能够在 Eclipse 中看到它们,而不必使用外部浏览器。我认为等效的 javadoc 将是shift+F2,但它不适用于 c++ doxygen。

换句话说,当我的鼠标悬停在类的方法上时,工具提示提供了函数的实现(在 .cpp 中找到),而不是它的声明和与之关联的注释(在 .cpp 中找到)。 H)。我想在我的工具提示中看到后者。

有针对 c++ 用户的解决方案吗?

谢谢

4

1 回答 1

4

不幸的是,这是不可能的,我怀疑将来是否有可能。要详细解释,请进一步阅读。
在 C++ 中,您可以通过 2 种方式编写函数。

  1. 直接定义函数(可能是externinlinestatic
  2. 在头文件中声明函数,然后在实现文件中定义函数

现在 eclipse 总是选择实现,原因是一致性。在 C++(与 Java 不同)中,您可以在多个头文件中对函数进行许多前向声明,但定义始终为1 (ODR)。
如果将函数置于鼠标下,那么选择哪个声明?所以最好选择一个定义。尽管在类方法的情况下可能不会出现此问题。

回到你的问题:

工具提示提供函数的实现,而不是它的声明和与之关联的注释

最好的方法是在函数的实现中嵌入注释。换句话说,从下面选择 style-2:

样式-1

class A {
 ...
public:
  /*
   * description of the function
   */
  void foo ();
};
void A::foo ()
{
...
}

样式 2

class A {
 ...
public:
  void foo ();
};

/*
 * description of the function
 */
void A::foo ()
{
...
}

解决方法:按F3两次键,它将引导您通过定义进行声明。

于 2012-04-10T14:05:02.447 回答