这些PHPDOC属性的目的是什么？
这些PHPDOC属性的目的是为了提供代码的注释和说明，以便其他开发人员更好地理解和维护代码。PHPDOC是一种特殊的注释，它可以用来生成代码文档，并且可以提供代码的结构、参数、返回值等信息。PHPDOC属性包括@param、@return、@var、@throws等，它们可以用来描述函数或类的属性、参数、返回值等信息。这些属性可以帮助开发人员更好地理解代码的结构和功能，并且可以提高代码的可读性和可维护性。
相关·内容
2回答
我正在从别人那里读一些PHP代码，文件在每个方法之前都填满了注释。注释@access和@var是什么意思？
/**
* EE Superobject
*
* @access private
* @var object
*/
private $EE;
非常感谢！
浏览 0提问于2013-04-12得票数 3
回答已采纳
我正在记录我用PHP和phpDocumentor构建的一个程序。一切都很完美，但是文档显示我有将近100个错误，因为它正在读取一个我用来上传文件到我的服务器上的文件，但不是我创建的。是否可以忽略给我所有错误的特定文件？这是我正在执行以生成文档文件的命令：
phpdoc run -d /var/www/html/myprogram/ -t /var/www/html/myprogram/documentation
我尝试忽略的文件位于/myprogram目录中，如下所示：
/modules/module1/uploader.php
我找到了一些关于--ignore用法的信息，但我不知道这是否指的
浏览 0提问于2012-12-29得票数 4
回答已采纳
3回答
什么是PHP注释，我在哪里可以更多地了解它？我需要简单的例子来理解它。我在谷歌上搜过很多。不知何故，我达到了这个地步：
示例代码：
<?php
class AddressShipment{
/* Attributes of AddressShipment */
/**
* private TypePlaceShipment type
* @ORM\Id @ORM\Column @ORM\GeneratedValue
* @dummy
* @var long
*/
private $type;
浏览 3提问于2013-10-04得票数 1
我见过几个PHP文件，其中文档块的开头有一些特殊字符。它以/**#@+ some doc-text */开头，以/**#@-*/结尾。
这些符号是什么意思？
我发现这似乎在各种PHP框架(Zend、phpseclib、Magento)中使用，但找不到解释。
示例：
/**#@+
* Constants for keys of data array. Identical to the name of the getter in snake case
*/
const ID = 'id';
const CUSTOMER_ID = 'customer_id';
c
浏览 7提问于2016-01-10得票数 3
回答已采纳
1回答
特殊注释和预处理
、、、
是以下形式的注释
/*:[url=users/%id]:*/
使用现有的文档工具包(尤其是PHP)会有问题吗？或者任何其他的注释预处理器？(与相关)
浏览 0提问于2009-11-05得票数 0
回答已采纳
我正在学习twenty_eleven的主题，并有一些奇怪的地方。
是什么
* @package WordPress
* @subpackage Twenty_Eleven
* @since Twenty Eleven 1.0
*/
“平均”的用法是什么？一遍又一遍。
* @uses load_theme_textdomain() For translation/localization support.
* @uses add_editor_style() To style the visual editor.
* @uses add_theme_support() To add
浏览 0提问于2013-08-06得票数 0
回答已采纳
2回答
通过YII为Model类自动生成的代码，我了解到表列是通过注释(@property)注入到Model类中的。
<?php
/**
* This is the model class for table "tbl_project".
*
* The followings are the available columns in table 'tbl_project':
* @property integer $id
* @property string $name
*/
class Project extends CActiveRecord
{
浏览 0提问于2013-01-18得票数 3
回答已采纳
我有一个基类(让我们称之为A)和继承类(让我们称之为AA)。
在另一个抽象类中，我有：
abstract class DifferentClass{
/**
*@var A
*/
protected MyA;
}
在一个更不同的班级：
class MoreDifferent extends DifferentClass{
public function __construct(){
$this->MyA = new AA;
}
}
我的问题是，当我ctrl+left单击继承类中的MyA时，它将带我进入原始的A类文件。我想带我去看AA文件。
这样做的PHPdoc
浏览 0提问于2010-07-27得票数 0
可以使用.xml文件或.ini文件配置phpdoc。文档是模棱两可的，但是使用.xml文件似乎是目前首选的方法。同意吗？
我应该把.xml文件放在哪里？
根据..。
最简单的解决方案是将配置文件放在项目的根目录中，名称为: phpdoc.dist.xml。
他们把哪个目录称为“项目的根”？我什么都试过了。
/usr/share/pear/phpDocumentor,
/var/www/phpDocumentor,
/var/www,
似乎什么都起不到作用。
浏览 4提问于2013-12-12得票数 0
回答已采纳
在php 7.4中，我现在可以定义类属性类型：
class A{
/** @var string */
protected $string;
}
我现在可以这样做：
class A{
protected string $string;
}
那么，这样做是否值得呢？也就是说，是否值得重新编写我的代码库以使用此功能？
是否有性能提升？
浏览 3提问于2020-07-19得票数 2
2回答
为整个项目生成phpdoc的命令行是什么？
目录结构
/Users/macuser/Sites/my-project/
index.php
config.php
includes/
class/
test.class.php
include-a.php
docs-go-in-here/
我已经安装了PEAR phpdoc，并且能够创建单个php文件的文档，但我找不到如何创建整个目录。
浏览 2提问于2011-07-01得票数 1
回答已采纳
我的源代码使用PHP_CodeSniffer生成以下错误。“变量&$myVar的文档注释与位置2处的实际变量名$myVar不匹配”
PEAR.Commenting.FunctionComment.ParamNameNoMatch
代码：
/**
* Function comment
*
* @param object $newVar some comment
* @param array &$myVar some comment
*
* @return null
*/
private function _myFunction($newVar, &$myVar) {
浏览 1提问于2015-02-05得票数 0
当使用PHP __call使类扩展2个类时，可以使用@method来使IDE知道方法的存在。
但是，当要求IDE跳转到方法的声明时，您最终会出现在@ method -row上，一种不被卡住的方法是在上面或下面添加一个@see行。但是，如果添加该行和分隔符行，则PHPDoc的长度/高度是原来的3倍。
是否可以在同一行中添加@see？
看到了一些使用它的例子，以及在{}中使用它的一些例子。在我的IDE (PhpStorm)中测试了它，@see的跳转声明只有在一个单独的行上才能工作。
PHPDoc允许我们在与@method相同的行中使用@see吗？如果是的话，正确的语法是什么？
示例：
<?p
浏览 4提问于2017-10-15得票数 3
回答已采纳
我正在尝试将数据从json转换为DTO类。我正在使用。
但当我试图贬低。它不解析来自typed property的类型，我猜Symfony还不支持反序列化表单类型属性。是这样吗？我必须实现我的目标吗？
DTO：
class ElkUser
{
public string $partnerUuid;
public string $contractUuid;
public DealerInfo $dealerInfo;
}
class DealerInfo
{
public string $description;
public int $
浏览 2提问于2020-03-10得票数 7
回答已采纳
我在php评论中经常看到这个(@var)，完全不知道它是什么意思。请告诉我。
// example.php (taken from yii framework application code)
<?php
/* @var $this CategoriesController */
/* @var $data Categories */
?>
<div class="view">
<b><?php echo CHtml::encode($data->getAttributeLabel('idCategory&
浏览 53提问于2012-08-28得票数 24
回答已采纳
我在php文件中有这样的注释，用来构建我的swagger：
/**
* @OA\Get(
* path="/additional_roles",
* tags={"additional_roles"},
* summary="Get list of additional roles",
* description="Returns list of additional roles",
每次运行php-cs-fixer时，注释都会被替换为：
/*
* @OA\Get(
*
浏览 6提问于2020-05-15得票数 0
我有这样的代码：
/**
* Days to parse
* @var int
*/
const DAYS_TO_PARSE = 10;
...
我不认为对常量使用@var是正确的，而且我没有看到任何@constant PHPDoc标记。执行此操作的正确方法是什么？
浏览 1提问于2011-07-15得票数 85
回答已采纳
我想用phpdoc解析两个或多个文件夹。解析一个文件夹很好。
在文档中，我可以看到以下内容：
-d=-目录=“.”
提供要解析的源文件夹的逗号分隔列表。
但我不能用这些变体让它工作：
phpdoc.bat -dapplication\controllers\mnm，应用程序\库-t phpdoc
phpdoc.bat -d应用程序\控制器\mnm，应用程序\库-t phpdoc
phpdoc.bat -directoryapplication\controllers\mnm，应用程序\库-t phpdoc
phpdoc.bat -directory“应用程序\控制器\mnm”，“应用
浏览 3提问于2016-05-09得票数 3
3回答
我已经下载了NetBeans7.0测试版，因为我想让PhpDoc的功能更强大，但是我不能让它工作。我似乎被netbeans中PhpDoc的配置选项迷住了。它正在询问脚本位置，
但是无论我输入什么，我都会得到错误；
** ERROR *****************************************************************
* Sorry, can't find the php.exe file.
* You must edit this file to point to your php.exe (CLI version!)
* [C
浏览 0提问于2010-11-23得票数 5
回答已采纳
我在看，但想知道你们发现了什么有用的东西。我想要的东西，将有助于记录我们的代码，但也是程序和任务，经常在网站上执行。在linux/PHP/MySQL环境中，最好的解决方案是什么？
浏览 1提问于2011-07-14得票数 0
1回答
我使用依赖项注入容器，它通过一个方法返回准备好的对象，所以它如下所示：
echo $container->get('cookie')->getValue('abc');
get方法返回一个cookie对象，但是PhpStorm IDE (或任何其他IDE)不支持这一部分，我希望它告诉我cookie有哪些方法，但是在第二个->之后，IDE没有显示方法列表，我知道如果我将get结果保存在一个变量中，就可以通过注释行通知PhpStorm变量是什么类型，但是我搜索了我前面提到的解决方案(只有一行)。
浏览 0提问于2015-07-12得票数 1
回答已采纳
我想在Intellij/PhpStorm的另一种语言中开发对自己语法的支持。具体来说，我希望解析解析器对PHPDOC注释的某些部分进行分析。是否可以将我的解析器插入到另一个(php)解析器中？
我已经编写了我的解析器&语法，但是我想让它在没有自己的文件扩展名的情况下工作。
如果不可能，是否有办法修改PHP解析器的行为？
浏览 3提问于2015-07-27得票数 0
回答已采纳
4回答
我最近看到了一个有趣的代码库，其中一些参数通过注释传递给方法。它看起来像这样
/*
* @attribute default-method
*/
当然，这将声明被实例化的类的默认方法。
这是什么？它是如何做到的？有这样的例子吗？
它被用来控制返回的格式，等等，所以它看起来非常有趣，而且肯定会从我创建的类中删除很多垃圾。
浏览 0提问于2012-04-04得票数 0
回答已采纳
一般来说，这就是如何让我的IDE (PhpStorm 2017)识别我无法正式声明的变量的类型：
/*
* @var User $user
*/
foreach($users as $user){}
IDE知道$user属于User类。现在我正面临这样一种情况：
Yii::app()->user->login()
具体来说，IDE不知道user是什么类型。我收到警告：
通过魔术方法访问字段
所以我试着用：
/**
* @var User Yii::app()->user
*/
Yii::app()->user->login();
但这没什么区别。如何
浏览 2提问于2017-08-08得票数 2
回答已采纳
在定义PHP类时，哪个是首选/最佳实践？有没有什么我忽略的关键区别？
如果编写一个__set()魔术方法，并在其中放入一个switch()构造，并为我想要允许访问的所有私有成员提供案例，似乎会更干净、简洁和方便。它不会从类内部自动调用，但setFoo()也不会，所以如果我想在内部使用访问器/赋值函数，我必须显式地调用任何一种方法。
另一个不同之处在于，在类外部的代码中，我可以始终以与$obj->foo相同的方式访问成员变量，无论是公共的(直接)还是私有的(使用__set())，而不是使用许多单独的方法。
我想这主要归结于美学的选择。例如，如果我有关于购买的地址数据，我不希望有16个或更多
浏览 0提问于2009-10-07得票数 9
回答已采纳
我到处找遍了，但没有运气。“我的VS代码”主题中的DocBlock注释有3种不同的颜色(见截图)。我希望这一切都是灰色的(只有一种颜色)。我意识到这取决于主题本身(我正在使用Atom One Dark)。我怎样才能改变它，使评论文本将是一种颜色(灰色)？
我能够用此设置更改javascript的DockBlock注释，但它只适用于javascript，而不适用于PHP。
"editor.tokenColorCustomizations": {
"textMateRules": [
{
浏览 3提问于2020-10-03得票数 1
我不知道为什么我会看到这个错误。我是PhpStorm IDE的新手，当我在SublimeText2 2/3中开发时，我没有看到这种错误。
当我悬停在红色文本上时出现的错误是：@property-write
在我的用户模型类中，它看起来如下所示：
我做错了什么？修复这些错误的最佳实践是什么？
浏览 3提问于2017-02-04得票数 0
回答已采纳
3回答
我以前从来不太关心记录我的代码，但最近我开始从事一个开源项目，并且出现了需求。显然“首选武器”是PHPDoc但是..。
我真的找不到PHPDoc标准的一个规范。维基百科上有一个列出了一些属性的条目，还有一个phpDocumentor项目，据说它有一本更广泛的字典，但让我困惑的是，PHPDoc的权威指南在哪里？有没有一个单一的标准，或者是所有那些无数的phpDocumentor山寨货将PHPDoc“标准”(如果有的话)扩展到他们认为合适的任何东西。
如果我们假设phpDocumentor是创建和维护PHPDoc标准的地方，事情看起来相当严峻，因为已经死了大约4年了。更让我困惑的是，大约一个月前，
浏览 0提问于2012-01-02得票数 6
回答已采纳
当我用phpstorm编写phalcon代码时，我有一个特别的错误，我不知道如何解决。我喜欢看到每个页面顶部的绿色复选标记表示没有问题，但此错误阻止了绿色复选标记的显示。
所以这就是导致错误的原因：
$this->persistent->parameters = null;
如何修改代码以防止PHP Storm error:字段通过魔术方法访问
我知道这有点挑剔，但我很乐意解决这个问题
浏览 2提问于2015-09-16得票数 2
这是让我烦恼的事情之一。
我使用find()方法检索数据，并使用foreach进行迭代：
$ladies = ValentineQuery::create()->find();
foreach ($ladies as $maybe)
{
echo $maybe->getSeconddate(); //<-- DOES NOT AUTO HINT AT GETTER METHODS!!! arg
}
getSeconddate()实际上工作得很好，但不会自动提示可用的getter。
如果我使用findPk()方法，我的IDE将自动提示getter。
有同样的问题吗
浏览 1提问于2014-02-14得票数 0
回答已采纳
/** this */在PHP文件中是什么意思？它有什么特殊的含义吗?还是像/* comment */一样被当作一个普通的多行注释
浏览 5提问于2011-02-21得票数 1
回答已采纳
2回答
PHP5可以做一些(有限的) ，然而，在我看来，在现实世界的项目中，类型通常在文档注释中描述。例如，而不是这样：
/**
* Test method
*/
function test(SomeType $param1) {
...
}
更常见的是
/**
* Test method
*
* @param SomeType param1
*/
function test($param1) {
...
}
这两种方法的优缺点是什么？如果我认为PhpDoc方法更常见的假设是正确的，那为什么呢？为什么人们不更多地利用内置的语言特性呢？
编辑：第三个选项是将两种方法结合使用：
浏览 5提问于2014-12-19得票数 7
1回答
我正在建立一个用于学习目的的网页应用程序使用超文本标记语言，PHP，jQuery和MySQL。随着我的应用变得越来越大，交互越来越多，我开始感到困惑和混乱。因此，我想知道记录web应用程序的最佳实践是什么:方法、软件等。
浏览 0提问于2012-05-01得票数 3
回答已采纳
1回答
我在Typo3 6.2.9中遇到了以下问题：
当我使用f:link action和参数将一些对象传递给控制器时，这些对象将到达控制器，但它并没有像我发送的那样注册它们。要获得更好的解释，请参阅以下单个代码部分：
在partial：
<f:link.action action="new" controller="ForeignProductMeasuring" arguments="{planRow : planRow, plan:plan}">neue Dosierung anlegen</f:link.action>
在
浏览 1提问于2015-02-07得票数 0
我正在尝试使用phpDocumentor (这是我第一次不知道自己在做什么)。实际上，我只想在SublimeText 2和插件中使用它。你能一步一步地指导我，我该怎么做才能让它工作？下面是我现在所做的：(我使用的是Windows7)从下载phpDocumentor并将其放在某个地方。我已经为phpdoc/bin创建了系统路径(因此phpdoc.bat可以通过sublime插件执行)，然后还将系统路径添加到php (从WAMPserver安装)
当我尝试使用我的插件(或在控制台窗口中执行phpdoc )时，我得到这个错误：
Could not open input file: \phpdoc.p
浏览 0提问于2012-05-02得票数 18
我不明白为什么PhpStorm在这个方法上给了我下面的警告PHPDoc comment does not match function or method signature：
/**
* Create a new instance of the class
* @param string $classname Class to instantiate
* @return object the instance
* @throw FactoryException If the class is not instantiable
*/
private function newInsta
浏览 3提问于2012-03-22得票数 13
回答已采纳
3回答
--我正试图加快构建的速度，并且正在寻找一些关于如何这样做的想法。我目前使用Hudson作为PHP项目的持续集成服务器。
我使用Ant build.xml文件进行构建，使用类似Sebastian的的文件。不过，目前我只运行phpDocumentor、phpcpd和phpUnit。phpUnit也会生成Clover代码覆盖报告.
以下是一些可能的瓶颈：
phpDocumentor：需要180秒。我的项目中有一些大型的包含库，如awsninja、DirectedEdge、oauthsimple和phpMailer。我不确定我是否真的需要为这些开发文档。我也不知道如何使用我的build.xml文
浏览 4提问于2010-09-12得票数 5
回答已采纳
我对Java中的包概念有些熟悉，但我对Wordpress和PHP还不熟悉。
在模板文件(如header.php )中，当您包含@package符号时会发生什么？
<?php
/*
* @package MyTheme
*/
浏览 0提问于2013-01-09得票数 3
回答已采纳
2回答
我的代码中有如下函数返回对象(用于链接)：
/**
* Set properties
*
* @param $name
* @param $value
*
* @return \Boka10\Page\MenuItemConfig
*/
public function __set($name, $value)
{
$this->$name = $value;
return $this;
}
我想把这个函数变成一个特性，因为，基本上，它一直都是重复使用的
浏览 1提问于2019-03-13得票数 1
回答已采纳
2回答
我应该如何正确地使用PHPdoc来记录类中的可链接方法，如下面的示例所示-正确的用法是什么？
class myClass {
/**
* @return myClass
*/
function one()
{
return $this;
}
/**
* @return self
*/
function two()
{
return $this;
}
/**
* @return $this
*/
function three()
浏览 2提问于2011-08-25得票数 6
回答已采纳
我试图使用“php补丁”插件与视频工作室代码。
我读过这个主题：
我跟着所有的步骤。当我尝试格式化代码时，我会在下面的工具栏中看到一条简短的消息“php补丁已完成”。但是代码根本没有格式化。
这是我的设置，也许你会看到什么？精度:我在寡妇的环境里。
{
"editor.fontSize": 12,
"eslint.alwaysShowStatus": true,
"diffEditor.ignoreTrimWhitespace": false,
"editor.wordWrapColumn": 120,
浏览 17提问于2022-03-19得票数 0
<?php
class Hello
{
public function hello()
{
return "";
}
}
我有函数，我需要给出注释，并为相同的文档编写文档，如@param、@return。
我怎么能这么做？
我对PhpStorm非常陌生。
浏览 0提问于2016-09-03得票数 2
回答已采纳
我的问题是@package和@subpackage。
我去了建议链接(包和子包注释的目的是什么？)。在那里，我找不到可以应用于我的问题的任何东西，而是这个答案：“这些是PHPDoc标记--用于生成有意义的(和自动化的)代码文档”。这就是我现在拥有的：
/**
* Contains a list of all custom action hooks and corresponding functions defined for abc.
* This file is included in functions.php:
*
* @package theme-name
* @subpac
浏览 0提问于2013-01-23得票数 8
我下载了phpdoc，不管我做什么，他都会放弃：
Could not open input file: \phpdoc.php
在控制台中。此文件的路径位于path和php include的路径中。我确实用另一个php脚本尝试过他，它(从控制台)证实了这一点。我做错了什么？
浏览 3提问于2012-07-10得票数 2
回答已采纳
1回答
检查模型关系
、、
我正在尝试检查我的Eloquent模型，以找出它们与其他模型的关系。问题是关系被简单地定义为一个单一的方法，并且不存在关系的中心索引：
public function posts()
{
return $this->hasMany('Post');
}
为了检查所有关系，我需要提取方法列表，取出从Eloquent继承的方法，执行每个方法并检查返回类型：
$all = get_class_methods($model);
$inherited = get_class_methods('Eloquent');
$unique = array_diff(
浏览 0提问于2013-05-30得票数 1
2回答
拒绝来自恶意脚本的请求的最佳方法是什么？我有一个带有模块的Zend应用程序。我有一个扫描程序正在拨打的网址列表，比如mywebsite.com/phpmyadmin，/webmail，/cpanel等。现在，他们收到了404的网址，阻塞了我的错误日志。我想从应用程序中选择403个。(除非有更好的方法来处理)？
在Zend中到达403的最快方法是什么，这样它就不会不必要地在派单周期中翻滚？我在做下面的插件，但我不确定这是不是最好的方式：
public function preDispatch(Zend_Controller_Request_Abstract $request)
{
if
浏览 2提问于2010-12-14得票数 4
3回答
无论我走到哪里，我都会看到php的文档，如下所示：
/*
* stuff
* stuff 2
*/
我的问题是我能不能：
/*
Stuff 1
Stuff 2
*/
还是因为某种原因表示感谢？
浏览 3提问于2017-09-30得票数 1
回答已采纳
我知道大多数用于Eclipse的java开发工具都有一个快捷脚本，用于为所需的元素(包括页面级)添加JavaDoc块。
此外，我知道PDT将允许您通过Source菜单为许多内容“生成元素注释”。
有没有一个Eclipse插件(或者它可能是PDT中的标准插件，我刚刚错过了它)可以让你为给定文件中所有/部分支持的元素添加PHPDoc块？
浏览 0提问于2009-01-26得票数 8
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
实时音视频
即时通信 IM活动推荐
腾讯云开发者
