我知道写一个函数头并不是什么大问题，但我会承认我在这里很懒。
是否有任何工具可以生成函数头？我认为如果使用工具维护，在函数头中添加或删除字段很容易。
示例：
/****************************************************************************
* 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最伟大的粉丝。
一些简单的脚本也应该这样做。
答案 0 :(得分：1)
我建议将你要做的事分成两个独立的部分。
带有重新说明函数参数的行的注释块是没有用的。每个阅读代码的人都可以看到参数是什么。除非您要描述参数的用途，否则不要浪费一行代码。
另一方面，将函数及其变量提取到文档中很有用。正如bcr的评论中所提到的，doxygen在这方面做得很好。这是一个类似于javadoc的工具，但针对的是C / C ++，我已经广泛使用它了。
您可以在充满代码的目录上运行该工具，它会自动将这些功能及其参数提取到文档中。您不需要有注释块来获取函数和变量名称的基本文档。但是，如果您已经编写了一个包含该函数描述的块，那么它将包含在您的文档中。
在这里阅读更多内容： http://www.doxygen.nl/
答案 1 :(得分：0)
你的想法是什么？
在某些工具上，如Visual Studio，eclipse或其他大型IDE，它内置或插件（eclipse）。
在像emacs这样的编辑器上，在我编写它的时候，我编写了一个小脚本来完成这项工作。您可以通过一些cat，grep和sed来电轻松处理它。或者制作一些lisp代码来完成这项工作。