2010-08-21 46 views
27

我正在尋找一個用於doxygen代碼文檔的eclipse-plugin。我找到了eclox-plugIn(http://home.gna.org/eclox/)。我想知道,它怎麼會自動生成一個「空的」doxygen註釋,這個註釋可以在以後填寫,或者對於一個文檔eclipse插件有什麼更好的選擇?doxygen eclipse plugIn自動生成存根文檔?

例如,對於一個函數:void F(INT P1,P2 INT,...),它應產生:

/*! \brief ... 
    \param p1 ... 
    .. 
*/ 

PS 我使用主要是C/C++語言

回答

21

請參閱updated solution


老答案:
在Eclipse赫利俄斯在窗口 - >首選項,你可以這樣做: C/C++ - >代碼風格 - >代碼模板 - >評論 + 自動爲新方法的註釋和類

您可以在此配置評論樣式,但它不像應該那樣聰明。如果你發現更好的東西,我會非常高興......

+0

嗨,我試過了,但似乎沒有genrate評論...有東西我失蹤.. – 2011-09-27 23:31:05

+0

它只適用於生成的代碼...請參閱我的新答案。 – tauran 2011-09-28 21:42:03

+0

對於誰來尋找如何整合eclox在日食,請參閱https://github.com/theolind/mahm3lib/wiki/Integrating-Doxygen-with-Eclipse – shaffooo 2016-10-19 18:28:42

73

比我以前的答案不同的(更好的)做法:
在窗口 - >首選項 - > C/C++ - >編輯,
在右選項卡查找「文檔工具註釋」,並在「工作區默認」中設置doxygen

現在您可以在功能上方輸入/**並按下回車鍵。

/** 
int foo(int bar); 

成爲

/** 
* 
* @param bar 
* @return 
*/ 
int foo(int bar); 
+0

這是完美的,謝謝。 – Chase 2014-03-11 03:48:20

+0

準確地說我正在尋找的開關。乾杯。 – Alchete 2014-03-24 21:33:40

+2

不確定爲什麼這個明顯的東西不能在Eclipse Neon中工作? – 2016-07-12 06:08:42

4

對於項目的具體設置
在項目 - >屬性 - > C/C++通用:

  • 勾選啓用項目的具體設置
  • 選擇Doxygen的作爲文檔工具

然後在函數/方法的上面輸入/**,然後按回車就可以工作。請參閱here