php 魔術方法，未聲明屬性，數組的注釋 - 幫助ide跳轉，提高可讀性

php 魔術方法，未聲明屬性，數組的注釋 – 幫助ide跳轉，提高可讀性

2022 年 3 月 16 日
筆記
laravel, php, phpdoc, vscode, 技術, 數組, 注釋, 魔術方法

本人使用vscode編輯器。其他編輯器未測試。

經過1：

　　用laravel開發了一段時間，最麻煩的一點就是許多時候編輯器無法智慧提示和輔助跳轉。

　　有一款ide-helper的插件，感覺不是很好用，經常會跳轉到純聲明的文件中去，有時還會跳出兩個選項。就想著自己寫注釋實現。

成果1：

　　1.魔術方法（以laravel orm中query,scope等方法跳轉舉例）- 其中query返回，靜態關鍵字寫在類型前面

/**
 * @method static self query()
 * @method self find()
 * 
 * @method self active()
 */
class Order extends Model
{
    //此處寫return，無法被編輯器正確識別
    public function scopeActive($query)
    {}

}

　　2.未聲明的屬性(以laravel orm中欄位舉例) – 這個關鍵詞找了好久

/**
 * @property int $id
 */
class Order extends Model
{}

　　3.顯式聲明的注釋(輔助跳轉和智慧提示)

　　對屬性: @var

　　對方法: @return

var和property的區別，可參考:

　　//stackoverflow.com/questions/52982268/what-is-the-difference-between-method-property-and-variable-in-php

經過2:

易得: @return的數據結構，如果是索引數組的形式，可以在數據類型後面加上[]來表示。

這時我就在想，

1.如何相對標椎的注釋關聯數組。

2.對laravel orm查詢出的結果集: collection，如何進行注釋。

3.以父類傳輸時，如何幫助編輯器確認子類（這是添頭）

百度沒查到，滿頁相同內容的php注釋基礎知識=.=（查詢時發現netbean似乎有獨特的寫法，未深入了解）

成果2：

1.對數組的注釋(phpdoc)

    /**
     * @param array<int|string,Order>
     * @param array<int|string,mixed>
     * @param array<int,array<int,string>>
     * @param array<int,string[]>
     * @param array{output:string,debug:string}
     * @param array<int,array{output:string,debug:string}>
     * 
     * @param list<array{output:string,debug:string}>
     * 
     */
    public function f()
    {}

編輯器效果: (注意不要有空格，否則顏色不會正確渲染)