C 函数头生成器

Question

我知道写一个函数头没什么大不了的，但我承认我在这里偷懒了。

有没有生成函数头的工具？我认为如果使用工具进行维护，在函数头中添加或删除字段很容易。

例子：

/**************************************************************************** 
* NAME:        name                                     
* DESCRIPTION: text 
* ARGUMENTS:   args 
* RETURNS:     void
***************************************************************************/ 

如果明天，我打算添加两个新字段，“日期”和“可重入”，该工具应该可以做到这一点：

/**************************************************************************** 
* NAME:        name                                    (date) 
* DESCRIPTION: text 
* ARGUMENTS:   args 
* RETURNS:     void
* RE-ENTRANT :
***************************************************************************/ 

我能找到的最接近的是 http://www.vim.org/scripts/script.php?script_id=938。但是它依赖于 VI 编辑器，我不是 VI 的忠实粉丝。

一些简单的脚本也应该这样做。

Answer 1

我建议将您尝试做的事情分成两个独立的部分。

带有重新声明函数参数的行的注释块是没有用的。每个阅读代码的人都可以看到参数是什么。除非你要描述参数的用途，否则不要浪费一行代码。

另一方面，将函数及其变量提取到文档中是很有用的。正如 bcr 的评论中提到的，doxygen 在这方面做得很好。它是一个类似于 javadoc 的工具，但针对 C/C++，我已经非常广泛地使用它。

您可以在一个充满代码的目录上运行该工具，它会自动将函数及其参数提取到文档中。您不需要使用注释块来获取函数和变量名称的基本文档。但是，如果您编写了一个带有函数描述的块，它将包含在您的文档中。

在这里阅读更多： http://www.doxygen.nl/

Answer 2

你的想法是什么？

• 在 Visual Studio、eclipse 或其他大型 IDE 等一些工具上，它是内置的或插件 (eclipse)。

• 在一些像 emacs 这样的编辑器上，在我用它编码的时候，我写了一个小脚本来完成这项工作。您可以通过一些cat、grep 和sed 调用轻松处理它。或者编写一些 lisp 代码来完成这项工作。