【问题标题】:A doxygen eclipse plugIn automatically generating stub documentation? [closed]一个doxygen eclipse插件自动生成存根文档? [关闭]
【发布时间】:2011-04-02 00:57:52
【问题描述】:

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

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

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

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

【问题讨论】:

    标签: c++ c eclipse documentation doxygen


    【解决方案1】:

    与我之前的答案不同(更好)的方法:
    在窗口->首选项->C/C++->编辑器中,
    在右侧选项卡中查找“文档工具 cmets”,并在“工作区默认值”中设置 doxygen。

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

    /**
    int foo(int bar);
    

    变成

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

    【讨论】:

    • 这是完美的,谢谢。
    • 正是我一直在寻找的开关。干杯。
    • 不知道为什么这个明显的东西在 Eclipse Neon 中不起作用?
    • 这应该是最佳答案。
    • 非常感谢,这应该是公认的答案!
    【解决方案2】:

    见updated solution。


    旧答案:
    在 window->preferences 中的 eclipse helios 中,您可以执行以下操作: c/c++->代码风格->代码模板->评论 + 为新方法和类自动添加 cmets

    您可以在此处配置评论样式,但它没有应有的智能。如果你找到更好的东西,我会很高兴...

    【讨论】:

    • 嗨,我试过了,但似乎没有产生评论......我错过了什么......
    • 仅用于生成的代码...查看我的新答案。
    • 对于任何来寻找如何在 eclipse 中集成 eclox 的人,请参阅github.com/theolind/mahm3lib/wiki/…
    • 可以自定义 Doxagen 插件吗?例如,我希望它在添加函数注释时生成@brief关键字。
    【解决方案3】:

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

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

    然后在函数/方法上方输入/** 并按回车即可。见here。

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 2010-09-16
      • 2012-10-16
      • 2012-08-17
      • 2012-06-23
      • 2020-06-17
      • 2019-07-29
      相关资源
      最近更新 更多