一个doxygen eclipse插件自动生成存根文档?

时间:2010-08-21 12:04:33

标签: c++ c eclipse documentation doxygen

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

例如对于函数:void f(int p1,int p2,...),它应该生成:

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

PS 我主要用于c / c ++语言

3 个答案:

答案 0 :(得分:82)

与我以前的答案不同(更好)的方法:
在Window-> Preferences-> C / C ++ - > Editor,
在右侧选项卡中查找“文档工具注释”,并在“工作区默认”中设置doxygen

现在,您可以在功能上方键入/**,然后按返回。

/**
int foo(int bar);

变为

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

答案 1 :(得分:23)

请参阅 updated solution


旧答案:
窗口 - > 偏好 中的eclipse helios中,您可以执行以下操作: c / c ++ - > 代码样式 - > 代码模板 - >的 评论 + 自动为新方法和类添加注释

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

答案 2 :(得分:6)

对于项目特定设置
在Project-> Properties-> C / C ++ General:

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

然后在函数/方法上方输入/**,然后按Enter键即可。请参阅here