phpdoc 相关问题

phpDocumentor(phpdoc)是一个基于Javadoc的PHP自动代码文档工具。

记录(phpdoc)生成器(产生的方法)的最佳方式

对于 phpdocumentor2,记录文档的最佳方式是什么,一种生成器的方法。 我认为 @return 并不真正适用于产量,但我似乎找不到任何合适的替代方案。 难道只是垫子吗...

回答 4 投票 0

PHPStorm + PHPDoc — 我可以输入提示单个数组元素吗?

我有: $myarr['DB'] = new DB(); $myarr['config'] = new config(); 我可以以某种方式让 PhpStorm 准确地知道这些键中的内容吗?现在我看到关于变量和类属性的提示...

回答 8 投票 0

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

我想为我们公司的所有开发人员定义一个 PHP 文件/类/函数中的头注释标准。我想使用 PHPDoc 风格。 在C++中,通过Visual Assistant重构,我们可以轻松地

回答 1 投票 0

PhpDocumentor 指南链接缺失

我正在尝试创建从文档中的一个页面到 .rst 文件中的另一个页面的链接: 链接到另一个页面:doc:`另一个页面` 但是当我运行 PHPDocumentor 时 php phpDocumentor.phar -c .\ph...

回答 1 投票 0

如何将 Laravel 模型属性记录为已弃用?

我在 Laravel 中有一个雄辩的模型,我想使用 PHPDoc 中的 @depectated 标签将 user_id 属性标记为已弃用。 我可以将 @property 标签添加到我的模型中以记录 user_id bu...

回答 1 投票 0

如何在 VSCode 上为类/函数自动生成 phpDOC

知道如何在 VSCode 上生成 phpdoc 吗?我已经安装了 intellisense、intelephense 扩展,但是当我输入 /** 它只是添加 */ 所以它变得像 /** */ 就这样。没有自体基因...

回答 2 投票 0

PHP - 尝试迭代整数时的 PHPDoc 类型提示

我有这个代码 /** @var array{总计:整数,记录:数组} $response */ $response = $this->getResponse(); foreach($response['total'] as $value) { $this->saveRecord($value); } 应该...

回答 1 投票 0

是否可以在 PHP 中使用 phpdoc 从类变量定义参数类型

现在我有这个: 用户提供者类 { 受保护的字符串 $className = User::class; /** * @param 用户$实体 */ 公共函数 getData($entity): 数组 { $data['南...

回答 1 投票 0

PhpDocs:链接到“@deprecated”标签描述中的另一个方法?

是否可以链接到另一个方法/类/属性/等。在我的项目内嵌@deprecated 标签内?像这样: /** * 方法说明 * @deprecated 1.0 弃用的原因,我们...

回答 2 投票 0

PHP 文档@example 示例

我正在将 PHP 文档与我的产品集成,因为我计划允许用户更改插件内的各种内容。 到目前为止一切顺利,我的目录中有 phpdoc .phar,我可以解析 html 文件。乙...

回答 2 投票 0

使用类常量定义 phpstan 数组形状

有没有办法在phpstan中使用类常量来定义数组形状? 目的是使定义能够被PHP代码使用,否则我们必须重复定义(对于phpstan一次......

回答 1 投票 0

如何自动添加和更新文件头注释块?

许多源文件在文档的开头都有一个突出的文件头。例如: 许多源文件在文档的开头都有一个突出的文件头。例如: <?php /** * Template for header * * Description * * @Author: Author * @Date: 2020-11-26 09:19:12 * @Last Modified by: Author * @Last Modified time: 2020-11-27 10:08:51 * * @package WordPress */ ?> 这些评论是如何添加的?我能想到的可能的解决方案是: 手册 编辑器中的片段/功能 其他插件 有人知道适用于大多数编辑器的解决方案吗? 添加标题注释通常是自动化过程。 最简单的方法是在 IDE 中为每个新 PHP 文件配置标头注释。例如,PhpStorm 有用于此目的的文件模板。 另一个选项是像 PHP CS Fixer 这样的工具。您可以使用一个简单的命令配置标题注释模板并将其添加到项目中的所有文件中。 像 PHP CS Fixer 这样的工具是一个更好的方法,因为如果你想更改评论中的某些内容,你只需要更新配置文件中的模板并再次运行控制台命令即可。它将更新您项目中的所有文件。

回答 1 投票 0

如何自动添加和更新文件头注释块?

许多源文件在文档的开头都有一个突出的文件头。例如: 许多源文件在文档的开头都有一个突出的文件头。例如: <?php /** * Template for header * * Description * * @Author: Author * @Date: 2020-11-26 09:19:12 * @Last Modified by: Author * @Last Modified time: 2020-11-27 10:08:51 * * @package WordPress */ ?> 这些评论是如何添加的?我能想到的可能的解决方案是: 手册 编辑器中的片段/功能 其他插件 有人知道适用于大多数编辑器的解决方案吗? 添加标题注释通常是自动化过程。 最简单的方法是在 IDE 中为每个新 PHP 文件配置标头注释。例如,PhpStorm 有用于此目的的文件模板。 另一个选项是像 PHP CS Fixer 这样的工具。您可以使用一个简单的命令配置标题注释模板并将其添加到项目中的所有文件中。 像 PHP CS Fixer 这样的工具是一个更好的方法,因为如果你想更改评论中的某些内容,你只需要更新配置文件中的模板并再次运行控制台命令即可。它将更新您项目中的所有文件。

回答 1 投票 0

PHPDoc 中的闭包语法

我在 PHPDoc 中找不到任何关于 Closure 类型的文档。所以我的问题是如何定义发送到闭包的参数及其返回值? 例子: 我该如何描述...

回答 3 投票 0

如何在 PhpDoc 块中创建文件链接或在 PhpStorm 中创建注释?

是否有功能或插件可以创建指向本地项目文件的链接,如下所示: /** * @see ./views/templates/file.twig */ 公共函数渲染() { .. } 这对于跳跃非常有用

回答 2 投票 0

phpDocumentor生成类层次结构图

我发现 phpDocumentor 可以从我的 php 代码生成文档。我实现了使用 api 文档生成 html 文件。但我发现了一个名为“类层次结构图”的选项卡

回答 1 投票 0

PHP - 欺骗返回类型协方差以进行代码预测

考虑: 抽象类 BaseModel { 受保护的静态字符串$dataObjectClass; 公共函数 toDataObject(): ?IDataObject { 返回静态::$dataObjectClass::from($this); ...

回答 1 投票 0

如何使用 PHPDoc 对 Callable 的参数进行类型提示?

我有一个接受回调作为参数的方法。我想在 PHPDoc 中为类方法提供一个签名,概述要传递给回调函数的参数...

回答 4 投票 0

PHPStan 错误:方法应返回特定类型但返回混合

我在我的 PHP 8.4.2 项目中使用 PHPStan 进行静态分析,我遇到了返回多个类型或 null 的类方法的问题。这是我的带有类型提示和 PHPDoc com 的方法...

回答 0 投票 0

PhpDoc 未将变量从控制器传递到 Yii2 和 PhpStorm 中的视图

简化代码: 模型: /** * @return array{name:string,age:int,group:int} */ 公共函数 fetchStudent($id){ //从数据库中获取$id学生并返回数组 (...) } 我的控制器: $学生...

回答 0 投票 0

© www.soinside.com 2019 - 2024. All rights reserved.