在被调用方方法上方注释方法调用方名称

Question

项目中有没有特定的标准或风格来指定哪些方法是使用注释调用当前方法？

例如，假设从 UserController@indexMethod 和 UserController@storeMethod 调用了 callee 方法，因此我们在此处对其进行注释

/**
* calee method
*
* @callers UserController@indexMethod, UserController@storeMethod
*/
public function callee()
{
    print('callee method');
}

因此，如果我更改被调用方的参数，我可以轻松找到并更改调用方。

Answer 1

不要那样做。文档往往很快就会不同步。此外，大多数（如果不是全部）IDE 都提供相同的功能。

如果您使用 PHPStorm，例如有“查找用法”命令，它列出了该方法或 class 您的光标所在的所有位置。 VS Code（免费）也有这样的功能。

如果您遗漏了一个案例，Psalm 或 PHPStan 等工具也会报告丢失或错误的参数。

您应该使用合适的工具，这将为您节省很多 (!) 时间。

Comment method callers name above the callee method