2010-08-21 49 views
27

我正在寻找一个用于doxygen代码文档的eclipse-plugin。我找到了eclox-plugIn(http://home.gna.org/eclox/)。我想知道,它怎么会自动生成一个“空的”doxygen注释,这个注释可以在以后填写,或者对于一个文档eclipse插件有什么更好的选择?doxygen eclipse plugIn自动生成存根文档?

例如,对于一个函数:void F(INT P1,P2 INT,...),它应产生:

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

PS 我使用主要是C/C++语言

回答

21

请参阅updated solution


老答案:
在Eclipse赫利俄斯在窗口 - >首选项,你可以这样做: C/C++ - >代码风格 - >代码模板 - >评论 + 自动为新方法的注释和类

您可以在此配置评论样式,但它不像应该那样聪明。如果你发现更好的东西,我会非常高兴......

+0

嗨,我试过了,但似乎没有genrate评论...有东西我失踪.. – 2011-09-27 23:31:05

+0

它只适用于生成的代码...请参阅我的新答案。 – tauran 2011-09-28 21:42:03

+0

对于谁来寻找如何整合eclox在日食,请参阅https://github.com/theolind/mahm3lib/wiki/Integrating-Doxygen-with-Eclipse – shaffooo 2016-10-19 18:28:42

73

比我以前的答案不同的(更好的)做法:
在窗口 - >首选项 - > C/C++ - >编辑,
在右选项卡查找“文档工具注释”,并在“工作区默认”中设置doxygen

现在您可以在功能上方输入/**并按下回车键。

/** 
int foo(int bar); 

成为

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

这是完美的,谢谢。 – Chase 2014-03-11 03:48:20

+0

准确地说我正在寻找的开关。干杯。 – Alchete 2014-03-24 21:33:40

+2

不确定为什么这个明显的东西不能在Eclipse Neon中工作? – 2016-07-12 06:08:42

4

对于项目的具体设置
在项目 - >属性 - > C/C++通用:

  • 勾选启用项目的具体设置
  • 选择Doxygen的作为文档工具

然后在函数/方法的上面输入/**,然后按回车就可以工作。请参阅here