2011-09-11 49 views
17

是否有向Eclipse項目中的每個方法添加註釋塊(Javadoc樣式)的簡單方法,以及可能的類,以便稍後填寫它們?如何將評論塊添加到Eclipse中的方法?

+3

是的,你可以右鍵點擊一個方法聲明,然後點擊'Source> Generate Element comment''。儘管如此,稍後添加文檔並不是一個好主意......這是行不通的。在實施它之前或至少在實施它之後立即記錄每種方法! – home

+0

我意識到這一點,但更好的是,永遠不會:) –

回答

29

建議你可以通過method-per-method(Source - > Generate element comment)或者ALT+SHIFT+J來實現,但是我覺得這是一個非常糟糕的主意。評論僅在他們提供額外信息時纔有用。當您感覺需要更多信息時,請添加它。

對像「設置值」之類的設置人員發表評論或者自動生成的評論更糟糕,它根本沒用。

+4

+1;自動生成*所有文檔*由於過度的噪音而最終會適得其反。 –

+1

該方法將註釋塊添加到類變量和方法中。然而它只是在每個方法的頂部添加了一個普通的/ * * /,沒有其他細節。我記得使用程序爲PHP項目中的每個函數添加PHPdoc樣式註釋並提供許多細節。無論如何,謝謝你的答案。 –

+0

「設置值」的註釋類型實際上惡化了代碼的可讀性。 –

7

窗口|首選項| Java |代碼樣式|代碼模板

,你會發現2個特點:

  • 自動添加新的方法或類
  • 評論評論|方法|編輯...

您可以使用eclipse變量或靜態Javadoc文本編輯生成的註釋塊。

+0

以哪種方式我可以將方法評論應用到源代碼中?例如,在(源代碼 - >生成元素註釋)中,我們可以生成如此的類說明,是否有一些快速方法可以讓我們生成「生成方法註釋」。 – user454083

5

要通過方法添加評論選擇的getUser帶光標的getUser,然後按Alt + Shift + J它之前將在您的方法之上添加評論

/* 
* @param 
* @return User 
*/ 
public User getUser(); 
+0

這將添加類評論,對吧? – hirosht

+0

@hirosht是的 – David

0

使用以下步驟即可輕鬆完成。在eclipse中輸入 轉到Project - >生成javadoc - >按回車,然後選擇要記錄的項目。

0

Mac用戶:^ - - Ĵ

  • 選項 - ⌥
  • 控制 -^

Windows用戶: - Alt鍵 - J

PS:請確保您有JAutodoc插件安裝

2

簡單的事情是,你只需要輸入/ **,然後按在方法的頂部,在那裏你想生成評論請。它自動生成的元素評論。不需要長時間鍵入。