2015-05-27 36 views
13

我已經爲php文檔塊設置了代碼檢查,所以現在如果它們丟失或不完整,我會收到警告。如何爲PhpStorm中的整個項目更新和生成DocBlock?

Code inspection for PHPDoc

當我有一個類開放,我可以用Code > Generate > PhpDocBlocks生成它們或只是通過/*開始評論中的方法前,它會被添加。另外,如果現存的文檔塊不完整或錯誤,我可以使用Update DocBlock以便將方法的DocBlock與實際方法的簽名相匹配。

有沒有一種方法可以將這些文檔塊生成以及必要時將文檔塊更新應用於整個代碼庫而無需在每個類中手動初始化?

我在尋找批處理。

回答

20

在項目總覽中,您可以右鍵點擊一個文件夾並選擇Inspect Code。它也可以通過Code > Inspect Code獲得。

將彈出一個窗口,詢問您是否需要進一步的細節,您也可以預期整個範圍的範圍。

確保您的檢查配置文件包含PHPDoc。如果檢查已運行通過,那麼你將有一個PHPDoc的部分,

Result of Code Inspection

通過右鍵點擊你那麼可以Apply Fix甚至多個類。

5

檢查這個截圖:enter image description here

你可以閱讀更多關於創建文檔here

+1

這隻能產生在當前類的文檔塊。問題是關於整個項目中的所有課程。 – k0pernikus

相關問題