C函数头生成器

我知道写一个函数头并不是什么大不了的，但我会承认我在这里很懒。C函数头生成器

有什么工具可以生成函数头文件吗？如果使用工具进行维护，我认为在函数头中添加或删除一个字段非常容易。

例子：

/**************************************************************************** 
* 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最大的粉丝。

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

来源

2011-08-18 Kamath

添加或删除字段的是什么？ –

可能重复的http://stackoverflow.com/questions/1570917/extracting-cc-function-prototypes – lhf

doxygen做这个的一些版本... – bcr

你的ide是什么？

在Visual Studio，eclipse或其他大型IDE的内置或插件（eclipse）等工具上。
对于像emacs这样的编辑器，在编写它的时候，我写了一个小脚本来完成这个工作。您可以使用一些cat，grep和sed调用轻松处理它。或者制作一些lisp代码来完成这项工作。

来源

2011-08-18 16:52:35 jDourlens

我现在不使用ant ide，windows平台+ SourceInsight使用makefile在CYGWIN平台中构建。 – Kamath

我不知道sourceInsight，我不习惯windows环境。但是在任何平台上，您都可以编写脚本来轻松完成此任务：perl，lua或其他任何内容？我希望有人能比我更好地回答你的问题; – jDourlens

我建议把你要做的事情分成两个单独的部分。

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

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

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

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

来源

2011-08-18 23:34:14 asc99c

C函数头生成器

回答

相关问题