2011-08-18 75 views
2

我知道寫一個函數頭並不是什麼大不了的,但我會承認我在這裏很懶。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最大的粉絲。

一些簡單的腳本也應該這樣做。

+1

添加或刪除字段的是什麼? –

+0

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

+0

doxygen做這個的一些版本... – bcr

回答

0

你的ide是什麼?

  • 在Visual Studio,eclipse或其他大型IDE的內置或插件(eclipse)等工具上。

  • 對於像emacs這樣的編輯器,在編寫它的時候,我寫了一個小腳本來完成這個工作。您可以使用一些catgrepsed調用輕鬆處理它。或者製作一些lisp代碼來完成這項工作。

+0

我現在不使用ant ide,windows平臺+ SourceInsight使用makefile在CYGWIN平臺中構建。 – Kamath

+0

我不知道sourceInsight,我不習慣windows環境。但是在任何平臺上,您都可以編寫腳本來輕鬆完成此任務:perl,lua或其他任何內容?我希望有人能比我更好地回答你的問題; – jDourlens

1

我建議把你要做的事情分成兩個單獨的部分。

註釋塊的行重新聲明函數的參數是沒有用的。讀取代碼的每個人都可以看到參數是什麼。除非你要描述參數用於什麼,否則不要浪費一行代碼。

另一方面,將函數及其變量引入文檔是有用的。正如bcr的評論所述,doxygen在這方面做得很好。這是一個類似javadoc的工具,但是針對C/C++,我已經非常廣泛地使用它。

您可以在一個完整的代碼目錄上運行該工具,並且它會自動將函數及其參數一起提交到文檔中。您不需要有註釋塊來獲取函數和變量名稱的基本文檔。但是,如果您已經編寫了一個包含該功能描述的塊,它將會將其包含在您的文檔中。

在這裏閱讀更多: http://www.stack.nl/~dimitri/doxygen/