phpstrom 生成注释_phpstorm插入生成函数和类的文档注释

开发中我们经常需要对自己编写的函数和类进行文档说明，写明类的功能或者函数的参数类型以及参数的作用，还有函数的返回值等。

写清楚文档说明对于项目的后期维护和开发会有很大的帮助，也有利于开发团队之间的协同开发。养成写良好的文档也是非常重要的。

项目完成后还可以导出生成API文档说明。

PHPSTORM插入文档说明的方法是：在类、函数、变量上面输入 /** ，然后按回车即可生成文档注释。

一、未进行文档说明

例如下面的代码，当我们完成开发之后，想给它生成文档：

function getName(string $name,int $age){

return "名称为$name ，年龄为 $age";

}

未生成文档注释时，我们只能通过阅读代码了解函数或类的功能是到底做了什么。

二、生成文档注释

此时我们在函数名上面输入 /** 然后按回车，即生成了函数的相关信息。自动生成的信息包含了参数的类型，参数名称以及函数的返回值类型。

还需要我们添加补充说明信息。概述函数的功能，参数的含义，返回值的含义。

例如我们补充为：

/**获取用户的信息

* @param string $name 用户的名称

* @param int $age 用户的年龄

* @return string 返回用户名和年龄

*/

function getName(string $name,int $age){

return "名称为$name ，年龄为 $age";

}

现在就完成了一个函数的文档注释。

三、生成文档注释的最终效果

此时在函数名称上按快捷键 CTRL+Q 查看文档说明，最终如图所示