标签: phpdoc

我想用Eclipse填充注释标签@version和Subclipse或Subversion.CVS已自动完成此操作,但Subversion不是.这将非常有帮助.

我试图谷歌"@version",但似乎不可能.

CVS的例子:

<?php
 /* 
 * @author Spankmaster
 * @version $Id: file.php,v 1.47 2009-09-21 09:28:49 sp Exp $
 * @package mysoftware
 */

SVN示例:

<?php
 /* 
 * @author Spankmaster
 * @version $Id: $ -> stays empty
 * @package mysoftware
 */

请帮忙.....

我有以下代码:

class Orders{
    /**
     *
     * @var Supplier
     */
    private $suppliers; //Array of Supplier

    function loopAllSuppliers(){
        foreach($this->suppliers as $supplier){
            $supplier->/*no suggestion*/ //Can't get the method's to show here

            $this->suppliers->getSupplierName(); //methods in class Supplier show normally here
        }
    }
}

问题很简单.我只是想能够为我的变量声明一个类型,$supplier就像我用它做的那样$suppliers.

笔记:

• Supplier是一个具有公共方法getSupplierName()的类.
• 我正在使用Netbeans IDE.

我已经通过PEAR安装了PHP Documentor.但输出选项不起作用.当我使用简单的命令时

phpdoc -d source/path -t target/path --template responsive

它工作正常.但是当我使用像这样的-o或--output选项时

phpdoc -d source/path -t target/path -o PDF:default:*

它给出了以下错误.

[RuntimeException的]

"-o"选项不存在.

我尝试了其他输出格式,如-o HTML:Smarty:PHP和-o HTML:Smarty:默认但结果相同.

我正在浏览PHPDoc的文档,但找不到一个很好的方法来记录我发送给各种方法的Post变量.

因此,我开始研究Doxygen,希望它能为我提供更好的方法来记录所有这些变量.我的代码涉及很多AJAX请求,因此大多数变量都是通过post发送的.

我有一个很好的方法来记录doxygen中的post变量吗？我在确定运行标准参数标签时是否会出错时遇到问题.

如果没有,是否有另一个文件可能在这个过程中有用？或者我应该只是手动记录每个标志而忽略寻找自动记录工具？

谢谢!

我在PHP代码中使用@since注释.我对它的使用有疑问.假设我有一个执行特定任务的函数,它已在1.0版本中实现.

所以我现在有@since 1.0.

现在我继续更改函数的名称,尽管里面的代码保持不变.它应该现在说@since 3.0(当前版本)还是@since 1.0？

我有:

$myarr['DB'] = new DB();
$myarr['config'] = new config();

我可以以某种方式让PHPStorm知道究竟是什么内部的钥匙？现在我只看到变量和类属性,但不是数组键.

假设我有一个a抛出异常的函数$e.因此,根据phpdoc我应该有一个@throws关于定义的注释a.

当我有另一个函数b调用a

function b() {
   a();
}

@throw在b指示b可能抛出这种异常的定义上有一个注释是好的做法/坏习惯/正确/错误吗？

我想在刀片模板中考虑PHPdoc块.

PhpStorm 9,Laravel 5.1,刀片模板文件:

<?php
/* @var App\Models\User $user */
?>
...
<?= $user->email ?> <- autocomplete for the word "email" is working
...
{{ $user->email }} <- autocomplete not working

我尝试了不同的变种:

{{
/**
* @var App\Models\User $user
**/
}}
{{ /* @var App\Models\User $user */ }}
...
{{ $user->email }} <- autocomplete not working...
...
In such variant autocomplete works, but only within that block:
{{
/* @var App\Models\User $user */
$user->email
}}
...
{{ $user->email }} <- here …

我正在为一个宁静的API构建一些phpdoc - 我开始使用@paramdoc语法来通过POST来记录所需的params.

然而,在生成phpdoc之后,我注意到它拒绝列出这些参数,除非它们与输入变量完全匹配到方法本身.

@uses而@see并不好看,也不在这里太大的意义,当它涉及到PHPDoc的输出.doc的样式/外观与@param功能完美搭配.

有没有办法覆盖PHPDoc实施的规则,并允许它@param在文档中生成块,即使方法本身不存在param？

我使用 PHP 严格类型declare(strict_types=1);并通过项目声明类型。此外，我还在 PhpStorm 中启用了 PHPDoc 检查，例如Argument PHPDoc missing、Missing @return tag等。当我有明确的返回类型和参数类型声明时，我希望 PhpStorm 不显示有关 PHPDoc 的警告。

以下是 PhpStorm 方面的有效示例代码。

    /**
     * @param Request $request
     * @return JsonResponse
     * @throws DBALException
     */
    public function find(Request $request): JsonResponse
    {
        $user = $this->repository->find($request->get('id'));
        if (!$user) {
            throw new NotFoundHttpException();
        }
        return $this->json($user);
    }

正如我们所见，我有明确的参数类型Request $request和返回类型: JsonResponse声明，因此无需在 PHPDoc 中复制它们。

我想从 PHPDoc 中排除这一行

    /**
     * @param Request $request
     * @return JsonResponse
     */

没有来自 PhpStorm 的警告，但只有在我声明了类型提示的情况下。尽管如此，当我的代码没有类型提示时，我希望看到警告。

有可能实现吗？如果不是，是否存在某些 …