php文檔提示？

我一直在編碼php一段時間，並從未做過太多的文檔。當然，我會給出2個字的功能摘要，以後我可能會忘記它。我很快就開始了一個大型項目，並認爲這應該是我更好的文檔的跳躍點。php文檔提示？

那麼在文檔上有什麼好的提示嗎？任何不錯的IDE讓它變得有用/直觀？我目前使用notepad ++，但似乎沒有太多支持phpdoc的語法，那麼什麼是一個好的（最好是開源的）替代方案？

感謝，
最大

2011-09-28 Ben

你在找什麼樣的提示？這有點朦朧。你在問如何去做，或者使用什麼類型的程序？ –

我的意思是故意朦朧。我主要是在尋找一個幫助我自動開始記錄的程序，但更多地歡迎關於記錄風格/最佳實踐的提示。 – Ben

我使用的Zend Studio，它支持PHPDoc的非常好。實際上，它似乎使用您的PHPDoc註釋來協助完成自動完成，所以確保您具有準確的@param和@return值是很好的動機。它也做一些自動生成某些行動。一個免費的替代方案是使用PDT擴展的Eclipse，它可能使您獲得使用Zend Studio（基於Eclipse構建）的95％的效果。

來源

2011-09-28 22:31:01

+1 - 打敗我。我也使用Zend Studio，這是值得的錢，但如果你不想支付任何費用，使用PDT的Eclipse是一個很好的選擇。使用PDT的Eclipse應該默認支持phpdoc語法，以幫助您使用標記。我唯一的抱怨是這兩個應用程序都是基於Java的，這有時意味着它速度很慢，並且總是飢餓的內存，但我仍然認爲它們是一些最好的選擇。 – drew010

任何流行的IDE（Netbeans，Eclipse + PDT，Zend Studio等））應該支持標準的PHPDoc語法。

對於API文檔生成和一般的PHPDoc語法定義，我的建議是DocBlox。

來源

2011-09-28 22:37:52 Phil

PHPDoc運行良好。

我個人是NetBeans的粉絲，我發現它比基於eclipse的IDE執行得更好（儘管它仍然很慢並且內存很大，所以不那麼重要）。它會消耗phpdoc評論並使用它們來幫助你，並且還幫助你編寫它們。例如，如果在函數定義上面鍵入/ **，它將爲每個函數參數創建帶有@參數行的整個docblock。

也看看PHPDocumentor，或更新，更性感DocBlox，這兩者都創建漂亮的HTML文檔。

有點相關，如果你還沒有使用type hinting很好。這有助於IDE找出問題的原因，並允許PHP在您傳遞意外類型時發出警告。

來源

2011-09-28 22:37:59 timdev

php文檔提示？

回答

相關問題