PHP 中具有 PHPDoc 风格的标头注释的事实上的标准

Question

我想为我们公司的所有开发人员定义一个 PHP 文件/类/函数中的标头注释标准。我想使用 PHPDoc 风格。

在C++中，通过Visual Assistant重构，我们可以轻松生成如下所示的标题注释：

//////////////////////////////////////////////////////////////////////////// 
// Function Name: TestFun
// Description: Description of TestFun
// Parameters:  bParam1: Description of param1
//              nParam2: Description of param2
// Return Values: Description of return value
// Create on(YYYY-MM-DD): 2024-04-03
// Modified on(YYYY-MM-DD): 2024-04-03
// Author: xxx
// Note: NONE
////////////////////////////////////////////////////////////////////////////
int TestFun(BOOL bParam1, INT nParam2)
{
    return  0;
}

但是，在PHPDoc中，我检查了这个https://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.quickstart.pkg.html，但找不到标头注释的标准格式。我只能找到一些相关的标签，例如@param（记录函数参数）和@return（记录返回类型）。

Answer 1

例如，如果我们公司的开发人员使用 PhpStorm IDE，您可以设置样式，然后与您的团队共享配置。