クラスを使用してインポートする場合は、PHPDocでFQNを使用する必要がありますか？

Question

私はUserControllerクラスを持っており、useを使ってApp\Userクラスをインポートしています。内部にはUserのインスタンスを受信するshow()メソッドがあります。

namespace App\Http\Controllers; 

use App\User; 

class UserController extends Controller 
{ 
    /** 
    * Show user info 
    * 
    * @param User $user 
    * @return Illuminate\Http\JsonResponse 
    */ 
    public function show(User $user) 
    { 
     // Do something... 
    } 

} 

はそれが私がuseでクラスをインポートしていても、たPHPDocにUserの完全修飾名を追加することをお勧めしますか？

Answer 1

\JsonResponseとしてインポートされていない場合は、異なるクラスとして認識されるため、useという文がない場合はFQNを使用してください。

Userクラスの場合、短い名前を使用してください。

useステートメントでクラスをインポートし、docblockに短い名前を書く方が便利です。

また、クラスのエイリアスは、例えば、使用することができます。

namespace App\Http\Controllers; 

use App\User; 
use Illuminate\Http\JsonResponse as Response; 

class UserController extends Controller 
{ 
    /** 
    * Show user info 
    * 
    * @param User $user 
    * @return Response 
    */ 
    public function show(User $user) 
    { 
     // Do something... 
    } 

}