在Eclipse中更改doxygen注释样式

Question

有没有人知道如何在Eclipse CDT中编辑用于Doxygen评论的样式？

换句话说，键入/ **并按在一行上输入，然后函数会给我一个类似的东西：

/**
 * 
 * @param one
 * @param two
 * @return
 */
Foo(int one, int two);

我希望它给我一些类似的东西：

/**********************************************************************/
///
/// \param one
/// \param two
/// \return
/***********************************************************************/
Foo(int one, int two);

另外，如果有人知道如何将其绑定到键盘快捷键（例如 alt - shift - j for Eclipse JDT），请加上一个

此外，仅供参考，Eclipse CDT支持Doxygen的事实现在似乎是一个基于谷歌的鲜为人知的事实。有关详细信息，请参阅here。通过在“C / C ++常规”选项卡中选择“启用项目特定设置”并选择“Doxygen”，可以在项目属性下启用Doxygen。我的CDT版本是7.0.1，但我认为这在5.0版本中可用。

最后，偏好设置中代码模板下的评论部分无法根据我的测试完成此操作。

修改 见here。似乎评论样式是硬编码的。如果有人发现，我很想知道。我想模板现在是最好的，除非Javadoc风格适合你。

Answer 1

是的，这似乎是Eclipse CDT中的一个错误。

作为一种解决方法，我建议您创建一个自定义模板，可以使用 Ctrl + Space 组合键访问该模板。

在Eclipse Helios中： Window - ＆gt;偏好 - ＆gt; C / C ++ - ＆gt;编辑 - ＆gt;模板的

点击新建... 创建新模板，然后在名称字段中使用一些描述性名称，例如“comment-function”，并在 Pattern 字段中添加doxygen注释。确认并应用此更改。

在您的代码中，您可以转到函数声明上方的行，键入自定义模板名称的前几个字母，然后键入 Ctrl + Space 组合键

在这个例子中：

com<Ctrl+space>

将显示使用“com *”过滤的“内容辅助”对话框，您可以从中选择“评论功能”模板。

注意：

com<Ctrl+space+space>

将通过仅在“内容辅助”弹出窗口中显示“模板提案”来进一步过滤。

Answer 2

这是我在java评论中找到的配置

当我按照所示编辑时，我的java doc注释改为

尝试在php配置下查找类似的配置。

Answer 3

我可以通过以下方式获得您想要的一些方式： 首选项 - PHP - 代码样式 - 代码模板 - 注释。

我不确定这是否会让你使用反斜杠而不是@s作为你的关键字，但我认为它应该达到你想要的大部分。

Answer 4

从eclipse 2020-03开始，您可以使用以下选项的组合：代码模板使用/ ***** /创建您的页眉和页脚，然后在中间仅使用///在C / C ++中自定义样式->编辑器选项。

Answer 5

Doxygen标签使用这种基本格式。

/**
Your tags and such. It MUST have the /** and the */.
*/

绝对必须在整个Doxygen评论中有/ ** * /。如果您修改代码模板，它将执行您想要的操作。

建议的评论风格虽然错误。

/***************/ <-- These are terminated Doxygen blocks.
/// <-- These are used in xml style Doxygen blocks.
///
/// This isn't actually a Doxygen block and shouldn't work
/// if you run Doxygen on it.
///
/***************/ <-- These are terminated Doxygen blocks.

以下是大多数使用JAVA和eclipse编码的公司的标准。由于Doxygen对多种语言有效，因此对C / C ++也有效。

/**
 * Brief description.
 *
 * @param[in|out] <value> <description>
 */

如果您想使用xml样式标签......

/// <summary>
/// This is a summary of the class, blah, blah.
/// </summary>

您还希望确保eclipse也不会插入其他评论样式，否则您最终可能会在其他评论中插入评论。通常，混合评论样式（如/ ** * /和///.

）也是一个不好的规则

最后，如果您在创建类时选择自动生成注释，那么这些注释将自动放入。并且您可以在键入时使用eclipse自动生成方法标题（尽管我忘记了我是如何做到的）。