phpdoc如何记录@return成功和失败
phpdoc是一种用于记录PHP代码的文档注释的工具。它可以帮助开发人员生成代码文档，并提供代码提示和自动完成功能。在记录@return成功和失败时，可以使用以下方式：
- 使用@return标签注释成功和失败的返回值类型：可以在函数或方法的文档注释中使用@return标签来指定成功和失败的返回值类型。例如：
/**
* @return bool 返回操作是否成功，true表示成功，false表示失败
*/ function performOperation() {
// 执行操作的代码
if (/在上述示例中，@return标签指定了返回值类型为bool，true表示成功，false表示失败。
- 使用@return成功和失败的描述：除了指定返回值类型外，还可以在@return标签中提供成功和失败的描述。例如：
/**
* @return string 返回操作结果，成功返回"操作成功"，失败返回"操作失败"
*/ function performOperation() {
// 执行操作的代码
if (/在上述示例中，@return标签指定了返回值类型为string，并提供了成功和失败的描述。
- 推荐的腾讯云相关产品和产品介绍链接地址：腾讯云提供了丰富的云计算产品和服务，其中与PHP开发相关的产品包括云服务器、云数据库MySQL、云函数等。这些产品可以帮助开发人员轻松部署和管理PHP应用程序。具体的产品介绍和链接地址可以参考腾讯云官方文档：
- 云服务器：https://cloud.tencent.com/product/cvm
- 云数据库MySQL：https://cloud.tencent.com/product/cdb_mysql
- 云函数：https://cloud.tencent.com/product/scf
请注意，以上答案仅供参考，具体的答案可能因实际情况而异。
相关·内容
我通常用phpDocumentor样式的docblock记录我的PHP函数定义：
/**
* This is a summary of this function.
*
* @since 1.0.0
*
* @return int
*/
function my_return_something() {
return 20;
}
我的问题是，我应该如何记录一个匿名函数？例如：
$length = function() {
return 20;
};
浏览 0提问于2015-12-22得票数 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
回答已采纳
1回答
我使用phpDoc为我的PHP应用程序生成文档，但我也喜欢它的错误页面。我喜欢它捕获无文档的单元，因为我不应该提交无文档的代码。不过，我想让它绊倒詹金斯。
在我与Jenkins一起使用的./script/test文件中，有这样的设置：
phpStan
phpUnit
如果其中任何一个失败，那么Jenkins就会失败(非零退出代码)，我知道如何修复它。我想把phpDoc添加到这个组合中。我目前正在使用以下命令：
phpdoc -d ./src/Application -t ./public/docs/phpdoc
我看到了一个错误，但是phpdoc返回的错误代码是零。有没有办法让
浏览 0提问于2018-01-25得票数 1
我使用标准来注释PHP代码和，以生成一个API文档。
我知道有很多标签可以用来显示信息。
define()语句、函数、类、类方法和类vars、include()语句和全局变量都可以记录在案。
但是现在我想记录一下函数中的变量。
例如，假设我有这样一个函数：
/**
* @param Request $request
* @param $course_id
* @param $lesson_id
* @param Content $content
*
浏览 1提问于2016-07-18得票数 3
回答已采纳
我正在使用PHPDocumentor2记录一个PHP项目。具有讽刺意味的是，PHPDoc的文档并不太详细。我完全理解如何注释文件、类、函数和变量，但是如果在if语句中定义了一个变量或常量，我应该如何注释它？
示例：
if ($foo==$bar) {
define('FOOBAR',$foo);
} else if ($foo>$bar) {
define('FOOBAR',$bar);
} else {
define('FOOBAR',$foo+$bar);
}
显然，我不想添加3个注释，文档应该真正解释if语句，
浏览 0提问于2012-08-29得票数 0
1回答
我希望使用具有通用功能的抽象基类进行扩展，但我不知道如何准确地指定返回类型并让PHPStorm检测它。
下面是一个例子。我是否可以在PHPDoc中记录AppleFactory::make()返回AppleInterface和OrangeFactory::make()返回OrangeInterface的方式？
<?php
namespace App\Factories;
abstract class AbstractFactory {
/** @var array $drivers */
protected $drivers;
/**
* insta
浏览 0提问于2017-05-03得票数 1
回答已采纳
我有这样的代码片段：
$pstmt = $connection->prepare($sql);
foo($pstmt);
现在我想记录一下"foo“方法，它需要一个准备好的语句。
但我只找到了\mysqli_stmt类。
开始编辑
一个“更完整”的例子
$connection = pwm\MySQLHelper::getConnection();
$pstmt = $connection->prepare($sql);
$pstmt->bind_param("s", $fbToken);
toJSON($pstmt);
$pstmt->close
浏览 2提问于2016-03-05得票数 1
回答已采纳
1回答
是否有一个PHP编码标准明确定义了如何为属性和方法编写docblock注释：
@var
@param
@return
@throws
包括他们之间的正确间隔？
涵盖代码本身，但不强制使用注释。
浏览 1提问于2012-12-07得票数 2
回答已采纳
1回答
当我在PDT中记录我的方法时，如果方法的返回可能是一个数组，它会生成以下类型的文档/类型提示：* @return :Ambigous <\CodeBase\Node\DataNode，NULL>
我已经查找过这个文档，并找到了一些好的文档，但是对于“多类型”和“模糊”，没有什么好的。
是否有任何文档涉及如何最好地利用这一点，以便使用类型暗示？是否有可能定义返回的数组结构:例如，返回的数组包含一个字符串键和某种对象--对"foreach“循环有用吗？
浏览 4提问于2016-03-26得票数 0
回答已采纳
是否有一种方法来记录某个类对于另一个类中定义的每个方法都有神奇的方法？
我使用的是PhpStorm，所以我很乐意使用任何能够自动完成的解决方案。
class A
{
// a bunch of functions go here...
}
/**
* Class B
* What should go here to make it work???
*/
class B
{
private $aInstance;
public function __construct() {
$this->aInstance = new A();
}
public fu
浏览 3提问于2016-11-07得票数 10
回答已采纳
我尝试在GitLab中集成phpdoc，这样每次我上传我的php代码时，文档都会自动生成。我是GitLab CI的新手。
它总是失败，因为它找不到phpdoc。我试着用composer来安装它，但是没有成功。
我的.gitlab-ci.yml如下所示
image: php:5.6
# Select what we should cache
cache:
paths:
- vendor/
before_script:
# Install git, the php image doesn't have installed
- apt-get update -yqq
- apt-
浏览 33提问于2018-12-10得票数 2
我有一个要记录的类。有一个保存类实例的变量，它将在构造函数中初始化。我想知道如何记录(或放置标签)，以便正确反映变量类型。
到目前为止，我已经这样做了：
/**
* Holds the instance of ParseMessage class
*
* @access private
* @var ParseMessage
*/
private $_parse_message;
该成员生成的单据如下：
Holds the instance of ParseMessage class
$_parse_message : **\ParseMessage**
我想在变量的类型之前删除这
浏览 2提问于2012-07-25得票数 3
回答已采纳
我们使用phpDocumentator来记录我们的php代码。php代码在不同的字典中。运行phpDocumentator的脚本如下所示：
./phpdoc -d dir1,dir2,dir3,dir4
每次我们添加一个新目录时，我都必须将这个目录添加到脚本中。
我想动态地做这件事。
ls -d ../*test*
这列出了所有需要的目录，但空格分开，而不是逗号分隔。
问题：
如何列出分隔的目录逗号？
如何将此列表作为-d参数添加到phpdoc脚本中？
浏览 7提问于2011-05-13得票数 28
回答已采纳
1回答
我发现自己处于这样一种情况，即开关外壳失效是最好的选择。我的意思是：
switch($bar)
{
case 0:
// do something
case 1:
// do more
break;
//more cases
}
目前，我的集成开发环境(phpStorm)正在抛出一个关于失败的警告。
在phpDoc中有没有一种公认的方法来记录这种有意的失败？
注：我知道，你们中的一些人肯定会说不要这样做，但我订阅了这个，这肯定是“最不糟糕的替代方案”。
浏览 23提问于2013-07-03得票数 25
回答已采纳
我正在记录我用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
回答已采纳
1回答
如果我用别名导入了一个类：
use My\Other\ClassName as OtherClass;
我应该如何记录那个类的类型？我用不用化名？
a) @return \My\Other\ClassName
b) @return OtherClass
c)的另一种方式？
浏览 2提问于2017-10-18得票数 0
回答已采纳
我正在尝试从reflectionMethods为我的一个类创建一个接口，但我遇到了一个问题，即getDocComments()方法在我的登台环境中失败了。
下面是我使用的测试代码：
<?php
class foo
{
/**
* Method bar description
*
* @param string $param1
* @param int $param2
* @return array
*/
public static function bar($param1, $param2 = 0)
浏览 12提问于2017-02-07得票数 1
回答已采纳
当匿名函数作为参数传递时，我应该如何记录它？例如：
// Call my_function(), passing 2 arguments.
my_function( 'foo', function() {
// Body of the anon function I'd like to document.
} );
提前谢谢。
浏览 1提问于2015-12-31得票数 6
1回答
我最关心的是记录控制器的操作，例如。您建议如何记录这些内容？我对生成文档的方法(例如phpdoc或doxygen)不太感兴趣，而更感兴趣的是一种方式。我是否应该像记录任何其他方法一样列出参数和返回值？
浏览 2提问于2009-08-19得票数 0
我用Codeigniter开发了一个遵循MVC模式的项目。
这意味着，例如，我有一个名为Items的控制器，它调用一个名为Items_model的模型，该模型从数据库获取文件，最后将这些文件传递给一个名为Item_view的视图。
现在我需要对其进行文档记录，并尝试使用phpdoc。
我的主要问题是，在控制器中的函数解释中，如何以函数的方式将该函数的行为与模型和视图联系起来，而不仅仅是以纯文本的形式编写名称。我读过关于包的文章，但不知道如何正确使用它
我希望你能帮助我，我是phpdoc的新手。
提前感谢并为我的英语表达歉意。
斯维德。
浏览 1提问于2010-08-13得票数 7
1回答
我有一个大型的php项目。我过去常常用NaturalDocs来记录它，但是我很长时间(几年)没有在构建过程中包含文档生成。
我最近开始使用composer并研究PSR。记录我的代码的唯一标准方法似乎是phpdocumentor的docblocks。
因为我的代码只是部分面向对象的，并且包含了很多过程文件，所以我不能只依赖于记录类和函数，但是我有很多文件级别的文档。
结果表明，phpdocumentor中不支持页面级的文档块(请参阅https://stackoverflow.com/questions/26925742/page-level-docblocks-and-phpdocumentor
浏览 0提问于2014-11-17得票数 4
1回答
我在试着了解phpDocumentor。我通常在每个文件中放一个类。我是否被强制记录文件和类？我只想记录类(为什么要记录文件？)但我会收到警告。
WARNING in comment.class.php on line 8: DocBlock would be page-level, but precedes class "Comment", use another DocBlock to document the file
我读过。
谢谢
浏览 0提问于2010-10-11得票数 4
<?php
class Hello
{
public function hello()
{
return "";
}
}
我有函数，我需要给出注释，并为相同的文档编写文档，如@param、@return。
我怎么能这么做？
我对PhpStorm非常陌生。
浏览 0提问于2016-09-03得票数 2
回答已采纳
1回答
我正在建立一个用于学习目的的网页应用程序使用超文本标记语言，PHP，jQuery和MySQL。随着我的应用变得越来越大，交互越来越多，我开始感到困惑和混乱。因此，我想知道记录web应用程序的最佳实践是什么:方法、软件等。
浏览 0提问于2012-05-01得票数 3
回答已采纳
我使用的是集成开发环境，在运行代码检查时遇到了问题。
我有一个返回对象集合的方法。Collection本身是一个对象，它有自己的方法，并实现接口：
class Repository
{
public function findByCustomer(Customer $user)
{
// ...
return new Collection($orders);
}
}
如果我将findByUser()文档记录为返回一个Collection，则代码检查可以理解此对象上的方法，但不能理解集合中包含的对象：
/**
* @return Coll
浏览 0提问于2012-05-23得票数 32
回答已采纳
通过PEAR安装了phpdocumentor，但当我尝试运行它时，我得到了这个错误：
bash: /Users/username/pear/bin/phpdoc: /usr/local/Cellar/php55/5.5.9/bin/php: bad interpreter: No such file or directory
我尝试对这两个文件进行符号链接，但没有成功。我可以做些什么来运行phpdoc
浏览 1提问于2015-08-25得票数 1
我在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
2回答
我在一家员工同时使用PHPStorm和Netbeans 8的公司工作。这对我们来说一直都很好用，直到我们最近开始在代码中添加更多的类型提示。
在PHPStorm中，在源代码中使用类型提示的正确方法如下
/** @var MyAwesomeClass $theObject */
$theObject = $orm->getMyAwesomeObject();
这是有意义的，因为记录函数的正确方法是
/**
* @param MyAwesomeClass $awesomeObjectArgument
* @param boolean $booleanArgumentsAreSilly
浏览 2提问于2014-07-23得票数 7
默认情况下，Squid会记录所有访问信息，包括“成功”和“失败”。我对只记录“失败”感兴趣。换句话说，我想做一些事情，比如只记录Squid拒绝的结果代码，或者，也不要记录成功的HTTP事务。无论我如何定义“成功”和“失败”，我都需要能够更具体地定义什么类型的访问信息Squid将写入日志文件。有人知道怎么做吗？
浏览 0提问于2015-06-17得票数 0
回答已采纳
1回答
有没有一种自动化的方法或工具可以用来记录cakephp应用程序。客户要求我为其他将在网站上工作的人提供技术文档，所以我需要一种列出所有视图、控制器、模型、组件和帮助器的方法。至少我需要一些框架文档，我可以用更有意义的说明和描述来填充它们。任何可以做到这一点的链接都会很有帮助。
浏览 1提问于2011-03-17得票数 1
回答已采纳
我正在尽我所能获得phpdocumentor，以允许我使用DocBook教程格式来补充它创建的文档：
我正在使用Eclipse
我已经通过PEAR在OSX机器上安装了phpDocumentor
我可以从php类运行并自动生成代码。
它不会格式化教程--我找不到解决方案
我尝试将.pkg示例文件移动到整个文件结构中，在子文件夹中使用与代码中引用的包类似的名称。我真的很困惑--如果有人能解释他们把.pkg和其他DocBook文件放在什么地方与他们正在记录的代码有关，以及他们如何触发phpdoc来格式化它的话，我会很感激的，我现在正在使用以下方法：
phpdoc -o HTM
浏览 1提问于2009-08-06得票数 3
回答已采纳
1回答
我在想一些事。通常，当我创建一个函数时，我会使用PHPDoc来记录该函数。这解释了函数的作用。
我的问题是，我是否也应该记录Codeigniter (或任何MVC框架)控制器中的函数？例如，这些函数主要是由路由调用的，只是为了显示页面，所以我不知道是否有必要对其进行文档记录。
浏览 1提问于2017-05-08得票数 0
2回答
可能重复：
试图找出通过phpdoc以一种合理的方式记录请求参数的最佳方法。具体来说，我有一些Zend控制器操作，它们通过GET/POST接收参数，但不是功能参数。这有道理吗？
/**
* Display a pagination/grid list of rows.
*
* @param string $_GET['order'] What field to sort on
* @param string $_GET['dir'] Direction to sort; either ASC|DESC
*
* @return void
浏览 0提问于2009-08-12得票数 6
回答已采纳
1回答
我有一个遗留代码，它的复杂度高于20。由于这个事实，我的管道失败了。这是来自管道的准确错误消息：
Function's cyclomatic complexity (36) exceeds allowed maximum of 20
我没有时间重构代码，因此，我正在寻找一个临时解决方案，比如抑制/忽略我的文件：
我试着用这些：
* @SuppressWarnings(PHPMD)
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
* @SuppressWarnings(PHPMD.LongVariable)
* @Suppress
浏览 0提问于2018-03-21得票数 1
我试图找到一种在PHP中处理数据库的面向对象方法，结果遇到了这个问题：
一路上，我看到了一些我不习惯看到的以"@“为前缀的评论。这是IDE添加的东西，还是在类中注释内容的一种面向对象的方式？请看下面的代码片段：
/**
* Get and set default Db configurations
* @uses static::config
* @param string|array $key [Optional] Name of configuration or hash array of configurations names / values
* @par
浏览 0提问于2014-04-16得票数 0
关于控制器函数的规范，我有一个问题。以下函数返回服务实体管理器，或者它应该：
/**
* @return EntityManager
*/
public function getEntityManager()
{
$entityManager = $this->get('doctrine.orm.default_entity_manager');
return $entityManager;
}
所以，返回线上写着
Return value is expected to be '\Doctrine\Orm\EntityManager',
浏览 4提问于2017-06-22得票数 1
回答已采纳
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
回答已采纳
1回答
是否可以在类声明之外记录方法、属性等？
<?php
// lib/classa.php
class ClassA {
public function __call($method, $args)
{
if ($method == 'testA')
return $method;
else if ($method == 'testB')
return $method;
}
}
正如您在上面看到的，类有一些IDE没有注意到的未记录的功能。
<?php
// app/index.php
浏览 4提问于2014-05-16得票数 0
我正在使用TYPO3，在我的扩展中有我自己的模型、控制器和存储库文件。在后端，我创建了一个没有任何问题的记录。但是，当我试图加载FE时，DataMapper.php中会出现以下错误
PHP Warning: class_parents(): object or string expected in /home/app/vendor/typo3/cms/typo3/sysext/extbase/Classes/Persistence/Generic/Mapper/DataMapper.php line 284
00284: if ($propertyData['type']
浏览 2提问于2019-03-27得票数 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
回答已采纳
我的源代码使用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编写后端代码。
在几个项目中，我为我的后端代码提供的AJAX响应类型编写了类型记录接口，这样前端开发人员(有时也是我，有时是其他人)知道应该期待什么，并得到类型检查等等。
在编写了一些这样的后端服务之后，响应的接口和相关类似乎也应该存在于PHP端。这让我觉得，如果我能用两种语言中的一种编写它们，并运行一些构建时工具(在类型记录编译器运行之前，我会用gulp任务调用它)来将这些接口导出到另一种语言，那就太好了。
这样的东西存在吗？有可能吗？实用？
(我知道PHP不是强类型的，但是如果接口是用PHP编写的，那么可能会有某种类型的暗示，比如导出者识
浏览 15提问于2015-10-16得票数 8
回答已采纳
我正在尝试找出一种在php mvc框架中记录控制器操作的好方法。对我来说很重要的是，有一种方法可以将操作的url放在其中，我的问题是我似乎找不到一种方法来适应phpdoc的模式。
浏览 2提问于2012-08-17得票数 6
回答已采纳
所以，我正在使用Silex微框架，我对记录闭包的正确PHPDoc方式很好奇。
require_once __DIR__.'/silex.phar';
$app = new Silex\Application();
$app->get('/hello/{name}', function($name) use($app) {
return 'Hello '.$app->escape($name);
});
$app->run();
如何记录GET闭包？
浏览 0提问于2012-05-18得票数 2
回答已采纳
我在看，但想知道你们发现了什么有用的东西。我想要的东西，将有助于记录我们的代码，但也是程序和任务，经常在网站上执行。在linux/PHP/MySQL环境中，最好的解决方案是什么？
浏览 1提问于2011-07-14得票数 0
我们必须如何在PHP中记录(用)用定义的常量？
我在文档中什么也没有找到，但在sample2.php中找到了以下示例(我看不出它有什么用)：
/**#@+
* Constants
*/
/**
* first constant
*/
define('testing', 6);
/**
* second constant
*/
define('anotherconstant', strlen('hello'));
谁能告诉我用phpDocumentor记录PHP常量的最好方法是什么？
浏览 1提问于2010-02-03得票数 14
回答已采纳
3回答
假设我有一个函数(显然是一个微不足道的例子)：
public function dot(){
return implode('.', func_get_args());
}
现在我知道我可以将其修改为
public function dot(array $items){
return implode('.', $array);
}
但对于某些功能，这不是一种选择。那么，如何使用docBlock记录函数的第一个版本，以便集成开发环境可以解释它可以接收无限的参数呢？
我见过一些使用以下方法的方法：
/**
* Joins one or more s
浏览 6提问于2012-12-09得票数 18
1回答
是否可以将类型信息添加到Doctrine查询结果？我在跟踪。
<?php
// show_bug.php <id>
require_once "bootstrap.php";
$theBugId = $argv[1];
$bug = $entityManager->find("Bug", $theBugId);
echo "Bug: ".$bug->getDescription()."\n";
echo "Engineer: ".$bug->getEngineer()-&g
浏览 8提问于2017-08-10得票数 1
回答已采纳
1回答
是否有任何方法可以测量我的所有PHP类和方法是否都有适当的PHPdoc注释？
也就是说，如果有足够的@param定义，@return语句.？
浏览 0提问于2014-09-03得票数 0
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
腾讯会议
实时音视频活动推荐
腾讯云开发者
