【PHP】关于PHP的文档注释写法之方法注释

前言:

之前的公司虽然使用 PHPstorm 来编写代码，并且也设定了相应的 PHPdoc 的格式，但总是觉得比较混乱，所以现在想总结一下注释的格式以及范例。

需求:

PHP版本: >=7.0

正文:

最后更新: 2022-01-21

例:

/**
 * 方法说明
 * 
 * @param [string|int|...] $param01 <参数说明>
 * @param [string|int|...] $param02 <参数说明>
 *
 * @return void
 */
public function sample($param01, $param02): void
{
    ... 方法体 ...
}

参考资料:

fig-standards/phpdoc.md at master · php-fig/fig-standards · GitHubhttps://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc.md