一个自动生成桩代码文档的Doxygen Eclipse插件？

Question

一个自动生成桩代码文档的Doxygen Eclipse插件？

33

我正在寻找一个用于 doxygen 代码文档生成的 Eclipse 插件。我已经找到了 eclox-plugIn（http://home.gna.org/eclox/）。我想知道如何自动生成“空白”的 doxygen 注释，以便稍后填写或者有更好的选择吗？例如，对于一个函数：void f(int p1, int p2, ...)，它应该生成：

/*! \brief ...
    \param p1 ...
    ..
*/

顺便说一下，我主要使用c/c++语言

- LonliLokli

3个回答

23

请参见更新的解决方案。

旧答案：
在eclipse helios 中，您可以在window->preferences中进行以下操作： c/c++->Code Style->Code Templates->Comments + 自动为新方法和类添加注释

您可以在此处配置注释样式，但它不太智能。如果您找到更好的方法，我会非常高兴...

- tauran

嗨，我尝试了那个，但似乎没有生成评论...我是不是漏掉了什么？ - HelloWorld_Always

这仅适用于生成的代码...请查看我的新答案。 - tauran

如果有人想要了解如何在Eclipse中集成Eclox，请参阅https://github.com/theolind/mahm3lib/wiki/Integrating-Doxygen-with-Eclipse。 - shaffooo

1

Doxagen插件可以自定义吗？例如，我希望在添加函数注释时生成“@brief”关键字。 - Danijel

7

针对项目的特定设置
在项目->属性->C/C++常规中:

选中启用项目特定设置
选择Doxygen作为文档工具

然后在函数/方法上方输入/**并按Enter即可。参见这里。

- Antonio

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- tauran · Accepted Answer

比我之前的回答更好的方法是：
在 Window->Preferences->C/C++->Editor 中，
在右侧选项卡中查找 "Documentation tool comments"，并在 "Workspace default" 中设置 doxygen。

现在您可以在函数上方键入 /** 并按回车键。

/**
int foo(int bar);

变成

/**
 * 
 * @param bar
 * @return
 */
int foo(int bar);