IntelliJ IDEA：PHPDoc注釋

PHPDoc注釋

此功能僅在Ultimate版本中受支持。
以下內(nèi)容僅在安裝并啟用PHP插件時有效！

對于文檔注釋，IntelliJ IDEA提供默認啟用的完成。當您鍵入/ **開始標記并按Enter鍵，或按下Alt+Insert并指定要編寫的代碼構(gòu)造（類，方法，函數(shù)等）進行文檔記錄時，IntelliJ IDEA會創(chuàng)建PHPDoc塊的存根。根據(jù)您的選擇，IntelliJ IDEA將創(chuàng)建所需的標簽或添加空的文檔存根。

如果您需要其他特定于PHP的標記，IntelliJ IDEA會提供代碼完成功能，以建議與當前上下文相關(guān)的標記名稱。如果某個標記具有多個值，則代碼完成會提供可用值列表。

在PHPDoc注釋中，IntelliJ IDEA支持符合ZEND，PEAR和其他編碼標準的格式選項。

源代碼中的PHPDoc注釋可用于快速文檔查找，這有助于您快速獲取任何已記錄符號的信息。您可以通過按Ctrl+Q在“文檔”工具窗口中打開它們以供查看。

啟用文檔注釋

1. 打開：編輯器|通用|IntelliJ IDEA設(shè)置的智能鍵頁面（Ctrl+Alt+S）。

2. 在“輸入” 部分，選擇或清除“插入文檔注釋存根”復(fù)選框。

3. 以下內(nèi)容僅在安裝并啟用Python插件時有效！

   對于Python，請滾動到文檔注釋存根選項中的插入類型占位符，然后根據(jù)需要選中或清除該復(fù)選框。

為代碼構(gòu)造生成PHPDoc塊

1. 要調(diào)用PHPDoc塊的生成，請執(zhí)行以下操作之一：

   • 將插入符放在所需的代碼構(gòu)造（類，方法，函數(shù)等）之前，鍵入空心塊注釋/**，然后按下Enter鍵。

   • 在編輯器上下文菜單中，選擇：生成|生成PHPDoc塊并選擇代碼構(gòu)造以生成PHPDoc注釋。

   • 按下Alt+Insert，然后選擇“生成PHPDoc塊”，并選擇代碼構(gòu)造以生成PHPDoc注釋。

   
   

   IntelliJ IDEA分析指定的代碼構(gòu)造，在可能的情況下提取參數(shù)數(shù)據(jù)，返回值，變量或字段，并在此基礎(chǔ)上生成文檔塊的存根。

2. 必要時描述列出的參數(shù)和返回值。IntelliJ IDEA根據(jù)“PHP檢查”設(shè)置檢查和處理注釋中的語法 。

在PHPDoc注釋塊中創(chuàng)建標記

IntelliJ IDEA分析指定的代碼構(gòu)造，在可能的情況下提取參數(shù)數(shù)據(jù)，返回值，變量或字段，并在此基礎(chǔ)上生成文檔塊的存根。如有必要，您可以填寫遺漏的信息。

1. 在PHPDoc塊中，選擇所需的空行，然后按下Ctrl+Space。

2. 從建議列表中選擇相關(guān)標簽。

3. 如果輸入的標簽有多個值，請按Ctrl+Space，然后從建議列表中選擇所需的值。

在PHPDoc注釋中配置格式

您可以配置PHPDoc注釋的外觀和類名的顯示。請注意，屬性的標記不再可配置，默認的@var標記會自動插入。有關(guān)詳細信息，請參閱https://github.com/phpDocumentor/fig-standards/pull/55。

1. 在“設(shè)置/首選項”對話框（Ctrl+Alt+S）中，轉(zhuǎn)到：編輯器|代碼風(fēng)格|PHP。

2. 切換到PHPDoc選項卡，通過選中或清除復(fù)選框來配置對齊。

3. 通過選中或清除“使用完全限定類名”復(fù)選框， 指定IntelliJ IDEA如何為屬性，函數(shù)參數(shù)，返回值和引發(fā)值等呈現(xiàn)類名 。

使用PHPDoc代碼檢查

IntelliJ IDEA提供了一組針對PHPDoc塊的預(yù)定義代碼檢查。這些檢查檢查類，方法，函數(shù)，變量和常量是否隨PHPDoc注釋一起提供，以及注釋中的標記是否與記錄的項匹配。

啟用或禁用PHPDoc檢查

1. 在“設(shè)置/首選項”對話框（Ctrl+Alt+S）中，選擇：編輯器|檢查。

2. 在打開的“檢查”頁面上，展開PHP下的PHPDoc節(jié)點。

3. 在打開的預(yù)定義檢查列表中，通過選中或清除檢查旁邊的復(fù)選框來啟用或禁用檢查。

檢查是否為某種類型的代碼構(gòu)造提供了PHPDoc注釋

1. 啟用缺少PHPDoc注釋檢查。

2. 在“選項”區(qū)域中，選中所需元素類型旁邊的復(fù)選框：類，方法，函數(shù)，變量或常量。

   如果方法或函數(shù)不包含任何參數(shù)或返回值， 要禁止報告缺少PHPDoc注釋錯誤，請選中“忽略PHPDoc而不使用@param/@return”復(fù)選框。