IntelliJ IDEA：PHPDoc注释！

最新推荐文章于 2024-06-06 09:33:29 发布

陈永佳

最新推荐文章于 2024-06-06 09:33:29 发布

阅读量620

点赞数 2

分类专栏：为霞而作 PHP开发微信小程序编程工具系列文章标签： IDEA PHPDoc注释

本文链接：https://blog.csdn.net/Mrs_chens/article/details/104656465

版权

为霞而作同时被 3 个专栏收录

295 篇文章 25 订阅

订阅专栏

编程工具系列

76 篇文章 2 订阅

订阅专栏

PHP开发微信小程序

13 篇文章 0 订阅

订阅专栏

📖摘要

今天分享下 —— IntelliJ IDEA：PHPDoc注释的一些基本知识，欢迎关注！

🌂PHPDoc注释

此功能仅在Ultimate版本中受支持。
以下内容仅在安装并启用PHP插件时有效！

对于文档注释，IntelliJ IDEA提供默认启用的完成。当您键入/ **开始标记并按Enter键，或按下 Alt+Insert 并指定要编写的代码构造（类，方法，函数等）进行文档记录时，IntelliJ IDEA会创建PHPDoc块的存根。根据您的选择，IntelliJ IDEA将创建所需的标签或添加空的文档存根。

如果您需要其他特定于PHP的标记，IntelliJ IDEA会提供代码完成功能，以建议与当前上下文相关的标记名称。如果某个标记具有多个值，则代码完成会提供可用值列表。

在PHPDoc注释中，IntelliJ IDEA支持符合ZEND，PEAR和其他编码标准的格式选项。

源代码中的PHPDoc注释可用于快速文档查找，这有助于您快速获取任何已记录符号的信息。您可以通过按 Ctrl+Q 在“文档”工具窗口中打开它们以供查看。

🚀启用文档注释

打开：编辑器|通用|IntelliJ IDEA设置的智能键页面（Ctrl+Alt+S）。
在“输入” 部分，选择或清除“插入文档注释存根”复选框。
以下内容仅在安装并启用Python插件时有效！
对于Python，请滚动到文档注释存根选项中的插入类型占位符，然后根据需要选中或清除该复选框。

⛳为代码构造生成PHPDoc块

要调用PHPDoc块的生成，请执行以下操作之一：
- 将插入符放在所需的代码构造（类，方法，函数等）之前，键入空心块注释/**，然后按下Enter键。
- 在编辑器上下文菜单中，选择：生成|生成PHPDoc块并选择代码构造以生成PHPDoc注释。
- 按下Alt+Insert，然后选择“生成PHPDoc块”，并选择代码构造以生成PHPDoc注释。

生成的代码如下：

<?php


namespace MyDemoSpace;


/**
 * Class myDemo
 * @package MyDemoSpace
 */
class myDemo
{
    /**
     * @var
     */
    private $user_name;

    /**
     * @param $user_frist
     * @param $user_last
     * @return mixed
     */
    public function add($user_frist, $user_last)
    {
        return $user_frist+$user_last;
    }

    /**
     * @return mixed
     */
    public function getUserName()
    {
        return $this->user_name;
    }
    
}