问题描述
是否有任何语言的特定标准或样式来指定哪些方法正在使用项目中的注释来调用当前方法?
例如,假设正在从UserController @ indexMethod和UserController @ storeMethod调用callee
方法,因此我们在此处进行注释
/**
* calee method
*
* @callers UserController@indexMethod,UserController@storeMethod
*/
public function callee()
{
print('callee method');
}
因此,如果我更改被叫方的参数,则可以轻松找到并更改主叫方。
解决方法
不要那样做。文档往往会变得不同步。此外,大多数(如果不是全部)IDE都具有相同的功能。
例如,如果您使用PHPStorm,则有一个“查找用法”命令,该命令列出了使用光标所在的方法或类的所有位置。 VS Code(免费)也具有这种功能。
如果您错过了一个案例,那么Psalm或PHPStan之类的工具也会报告缺少或错误的参数。
您应该使用适当的工具,这样可以节省大量时间(!)。