如何在eclipse-cdt中自动生成函数头注释

How to automatically generate function header comments in eclipse-cdt?

本文关键字：函数 注释 自动生成 eclipse-cdt      更新时间：2023-10-16

是否有一种方法可以自动生成eclipse cdt中函数的函数头?我看到过相关的帖子，要求使用Alt + Shift + J或在函数头之前键入/**并按Enter。然而，我想知道是否有可能得到一个预定义的函数头。我尝试在

中定义我的格式

C/c++>代码样式>代码模板>注释>方法

但无法在代码中使用

恐怕我有部分答案:

  1. 如果您转到-
  • C/c++→编辑:"文档工具评论";→工作区默认":氧

输入/** + enter，这将用参数&自动返回标签

我发现没有办法通过

自动添加其他字段
  • 如果你去windows -> preferences -> C/C++ -> Editor -> Templates，你将能够创建模板，eclipse将能够自动完成，当输入他们的名字。
    例如，您可以创建一个名为"author"的模板，将上下文设置为"doc comment"，并将所需的标记设置为模式。对于本例，我使用@author ${user}(注意变量的使用)。现在你可以开始输入'aut'，按ctrl+space自动完成，你的标签将被插入。

    我知道这可能不是你想要的答案，但它可能会有所帮助。我也曾尝试使用eclipse设置来自动生成这些内容，但是使用模板，将变得非常快，和可以更好地控制实际内容。

    • 我找到了一个小方法。

    在preferences>> C/c++>> Editor>> Templates中创建模板提供唯一的名称(如comfun)像我那样使用变量(${…}

    )

    保存模板

    现在在函数声明中输入唯一的名称并按ctrl+空格(注意没有标记文本)，这样eclipse就可以计算变量您所要做的就是将自动生成的文本移到函数上方。

    我希望这对你有帮助。

    /*-----------------------------------------------------------------------------+
|    F U N C T I O N   I N F O R M A T I O N                                   |
+------------------------------------------------------------------------------+
|  ToDo: check auto generated function comment                           |
|                                                                              |
|  Function Name:  ${enclosing_method}                                     |
|                                                                              |
|  Prototype at:   ${file_base}_tdf.h                                   |
|                                                                              |
|  Description:    add some useful content                                     |
|                                                                              |
|                                                                              |
|  Parameter:      ${enclosing_method_arguments}         |
|                                                                              |
|  Return Value:   ${return_type} OK               |
|                                                                              |
+-----------------------------------------------------------------------------*/
    相关文章：