正確注釋@return讓PHPstorm動態(tài)返回類

simon_chen 發(fā)布于2019-07-01 10:23 / 1740人閱讀

摘要：大意就是和差不多，但是父類方法子類調用，仍然返回父類。這個確切的對象實例，通常用于表示流暢的界面。這次我才真正意識到了注釋的重要性。。。最后，因為并不是我一個人在寫，所以沒有辦法進行大刀闊斧地改動，只能盡可能地優(yōu)化。

場景是這樣的，有一個BaseModel（繼承自ActionRecord），所有的其他model都繼承自它，然后其中有一個方法，簡單貼下這個類的代碼，：

class BaseModel extends ActiveRecord
{
    protected $temp_model;
    
    public function getCacheModel()
    {
        return $this->temp_model;
    }
}

這個方法的作用是取得在做參數(shù)驗證時，從數(shù)據(jù)庫查出的，緩存下來的實例對象。
這個時候，問題來了，我在取出這個對象的時候，PHPstorm沒有了提示（如方法提示，屬性提示等），按照一般的情況，只需要在方法前面加上@return注釋就可以了。

/**
 * @return static
 */
public function getCacheModel()
{
    return $this->temp_model;
}

我們繼續(xù)深入研究一下，關于這個static的意思，我特地在PHPDoc上查閱了一下，

static
An object of the class where this value was consumed, if inherited it will represent the child class. (see late static binding in the PHP manual).

Google翻譯一下，大意如下：
消耗此值的類的對象，如果繼承它將表示子類。
（參見PHP手冊中的后期靜態(tài)綁定）。

大概意思就是就會返回調用這個方法的類，如果是父類方法子類調用，那么將返回子類。

類似的還有2個

self
An object of the class where this type was used, if inherited it will still represent the class where it was originally defined.
$this
This exact object instance, usually used to denote a fluent interface.

直譯如下，
self:使用此類型的類的對象，如果繼承它，它仍將表示最初定義它的類。
大意就是和static差不多，但是父類方法子類調用，仍然返回父類。
$this:這個確切的對象實例，通常用于表示流暢的界面。
和self差不多。

但是到了這里，我的問題仍然沒有解決，無論我@return的值改成什么，仍然返回的是BaseModel，盡管我在這個getCacheModel()方法里打印 self::className() 時，出現(xiàn)的是子類名。

于是我們繼續(xù)往上面看，我是在controller調用的，controller的代碼如下：

public function actionCommitReward()
{
    $model=$this->goCheck(new TakeRewards(["scenario"=>"commit_reward"]));

    //獲取實際要修改的數(shù)據(jù)
    $reward = $model->getCacheModel();
}

看起來沒有什么問題，這個時候我們要注意了， $model 是由$this->goCheck()調用得到的，我們去看一下goCheck方法：

//驗證參數(shù)是否合法
public function goCheck($model, $dada = "")
{
    $data = $this->postData;//post傳入的數(shù)據(jù)
    if ($model->load($data, "") && $model->validate())//數(shù)據(jù)效驗

return $model;

    else (new PublicFunction())->returnWayTip("1001", PublicFunction::getModelError($model));//這里理解成拋異常
}

這里不規(guī)范的地方出現(xiàn)了，由于這里傳入的是model（對象類型），所以PHPstorm并沒法知道我們具體傳入的是什么類，加上注釋后：

/**
 * @param object $model
 * @param string $dada
 * @return model1|model2
 */

這樣后，問題“勉強解決”。只是每增加一個表，會需要在@return里增加表相對應的類名，而且會有類本來不應該存在的屬性被提示。

為什么這里不能用static呢？因為這里是$this調用的，返回controller類，并沒有什么用，而這個也導致了后面使用$model->getCacheModel()方法時，沒有辦法正常識別應該返回的類（返回什么類取決與goCheck的@return注釋是什么）。

當然你可以不寫注釋，那么你會發(fā)現(xiàn)，所以的提示都沒有了。
這次我才真正意識到了注釋的重要性。。。原來PHPstorm之所以都提示，都是因為大家按PHPDoc的規(guī)范寫了注釋啊！

最后可能有同學會問了，為什么不把goChekc方法放到BaseModel里呢？對的，實際上規(guī)范的做法是應該這樣的，但是因為我這樣把Yii::$app->request->post()賦值在controller里的$this->postData里（雖然這樣方便一丟丟），而且在做token換id的一些操作了進行了手動賦值，所以沒有辦法，因為在model獲取不到這個postData，當然你一定要挪進去也是可以的，只不過每次都需要傳參$this->postData，見仁見智吧。

但是，這2個方法都并不規(guī)范，$this->postData = Yii::$app->request->post(); 把全局的變量變成了一個局部變量，規(guī)范的做法應該是使用Yii::$app->request->post($name,$dafaultValue)來給post數(shù)據(jù)賦值。

最后，因為并不是我一個人在寫，所以沒有辦法進行大刀闊斧地改動，只能盡可能地優(yōu)化。BTW，希望大佬們有更好的意見可以說說，因為個人比較經(jīng)驗也比較不足，都是自己摸索。

GPU云服務器云服務器 return返回函數(shù) java 代碼注釋學生類 python 類返回動態(tài)數(shù)組類

文章版權歸作者所有，未經(jīng)允許請勿轉載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉載請注明本文地址：http://systransis.cn/yun/29124.html

Mac OS xDebug PhpStorm 快速配置

摘要：確定環(huán)境的干凈。這一步要優(yōu)化的話應該是做一個類似緩存的機制，對于這種配置加載的性能提升所以我們在調試必然是要在這里配置環(huán)境的接口。前言在網(wǎng)上找了一些相關配置的例子，覺得很多比較復雜，并且配置項過于多了，有很多冗余并不是最開始就需要的配置，所以寫一下記錄，也方便以后自己查閱。一、brew 安裝 php 在 Mac OS 這邊不需要手動去下載編譯打包，直接使用 brew 進行快捷安裝...

forrest23 2019-07-01 12:18 評論0 收藏0
如何把phpStorm打造成自己的專屬IDE?

摘要：本身是一款收費的軟件，有經(jīng)濟基礎的還是建議購買注冊號，支持正版。選擇自己喜歡的風格，即可。如何安裝自己下載的主題在官方主題下載自己喜歡的主題，下載下來的是格式的，然后將文件拷貝到的配置目錄里。 php開發(fā)神器之一，必然會說到phpStorm，工具的強大之處是有目共睹的，開發(fā)工具即使再強大，功能再齊全，也是一種工具，重要的是你怎么看待它和使用它。之前一直用的zend studio，最近試...

Forelax 2019-07-01 12:14 評論0 收藏0
每一位JSer都應當掌握的注釋標記

摘要：表示該函數(shù)接受可變數(shù)量的參數(shù)，并指定一個類型的參數(shù)一個可選參數(shù)可選參數(shù)，默認值指示參數(shù)是可選的。一個注釋塊中您可以包含多個標簽。簡介注釋標簽在代碼注釋中的作用非常大，但是可能很多同學在平常開發(fā)中會忽略這些標簽的作用，所以我這邊特地整理一些常用的注釋標記，通過圖文展現(xiàn)形式，希望能幫助你能更好理解每個注釋標簽的作用. 想必掌握這些注釋標簽之后，不光對您今后的自己代碼編寫，還是閱讀優(yōu)秀源...

Salamander 2019-08-23 18:17 評論0 收藏0
PHP編碼規(guī)范

摘要：為什么需要編碼規(guī)范為了提高工作效率，保證開發(fā)的有效性和合理性。在文件編碼中，選擇推薦在換行符中，選擇推薦文件命名程序的文件名和目錄名都采用有意義的英文命名。最后最后說的是，本規(guī)范不是強制，也不是標準?；貜途幋a規(guī)范即可。為什么需要編碼規(guī)范？為了提高工作效率，保證開發(fā)的有效性和合理性。為了提高代碼可讀性和可重復利用性，從而節(jié)約溝通成本。本文主要參考了 PEAR 規(guī)范，并進行適當...

xuweijian 2019-06-27 15:27 評論0 收藏0
Laravel 超好用代碼提示工具 Laravel IDE Helper

摘要：是一個極其好用的代碼提示及補全工具，可以給編寫代碼帶來極大的便利。例如事件將返回一個對象，利用文件您可以調用并且它將自動完成的方法。提示您可能需要重啟使文件生效。 showImg(https://segmentfault.com/img/remote/1460000014528926); Laravel IDE Helper 是一個極其好用的代碼提示及補全工具，可以給編寫代碼帶來極大的...

wemallshop 2019-06-28 18:48 評論0 收藏0