时间戳

首页 > 解决方案 > 在被调用者方法上方注释方法调用者名称

javascript - 在被调用者方法上方注释方法调用者名称

问题描述

是否有任何语言的特定标准或样式来指定哪些方法使用项目中的注释调用当前方法？

例如，假设callee方法是从 UserController@indexMethod 和 UserController@storeMethod 调用的，所以我们在这里评论它

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

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

标签： javascriptpythonphpcoding-style

解决方案

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

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

如果你错过了一个案例，像 Psalm 或 PHPStan 这样的工具也会报告丢失或错误的参数。

您应该使用适当的工具，这将为您节省很多（！）时间。

推荐阅读