2009-07-26 80 views
10

我正在用Eclipse + PDT進行開發。我一直在將phpdoc註釋添加到我的代碼中,但實際上從來沒有在Eclipse中生成結果文檔。我該怎麼做 - Eclipse中是否有一些功能,或者是否應該在外部完成文檔生成?PHPDoc文檔生成器進出Eclipse嗎?

回答

5

要生成文檔,您應該使用phpDocumentor,它可以作爲PEAR軟件包安裝。

然後,你必須從命令行調用它;實際上,我從來沒有見過從Eclipse PDT調用它。

一個很好的解決方案是擁有一個持續集成的平臺(例如使用phpUnderControl),並集成到您的構建配置文件中創建phpdoc;這樣,每當有人提交(或每天一次,或者只要你想要^^),就會生成phpdoc。在Eclipse PDT中,您可以調用「外部工具」(請參閱​​菜單中的「運行>外部工具」)。這將允許你啓動phpdoc命令(就像你從CLI執行的一樣);但它明確地不像Zend Studio提供的那樣用戶友好 - 不是同樣的價格,儘管^^

+0

我用ant來構建我的php項目,並且通常有一個doc目標。 Eclipse與螞蟻玩得很好。你也從日食中運行phing。 – 2009-08-13 03:27:16

1

是的,有一個嚮導在Zend中這樣做。看看這個brief guide

或者,您可以創建一個外部啓動配置來調用標準phpDocumentor

  1. 選擇運行 - >外部工具 - >外部工具配置...
  2. 在左側窗格中,選擇程序,則新圖標(最左側的圖標窗格的上方)。
  3. 在右側窗格中,選擇Main選項卡。
  4. 在名稱:字段中輸入generate_doc。
  5. 在位置:字段中輸入phpdoc cli工具的路徑。
  6. 在Arguments字段中輸入任何必需的參數,例如爲當前項目輸入$ {project_loc}。
  7. 要運行外部配置,請選擇運行。

重新運行配置,你有幾個選擇:

  1. 選擇菜單欄中external tools icon http://help.eclipse.org/ganymede/topic/org.eclipse.cdt.doc.user/images/icon%5Fext%5Ftools.png"外部工具圖標,然後單擊generate_doc
  2. 選擇運行 - >外部工具 - > generate_doc
  3. 按Alt + R,E,1(假設generate_doc是列表中的第一項,否則選擇合適的編號)
+0

謝謝,但我使用普通的Eclipse + PDT,顯然沒有這樣的選項。 – AlexA 2009-07-26 13:52:19

2

另一個生成文檔的好工具是ApiGen。它不需要使用PEAR進行安裝(但包含它),它可以像獨立軟件包一樣使用。

+0

我們如何爲windows安裝`ApiGen`?我下載了`phar`軟件包,但不知道如何繼續。 – 2016-01-28 15:20:38