jjzjj

Docblocks

全部标签

PHP Docblock #@+ 含义

PHP文档block中以下内容的含义是什么:#@+zend框架代码中的一个例子:/**#@+*@conststringVersionconstantnumbers*/constVERSION_10='1.0';constVERSION_11='1.1';/**#@-*/我假设它用于对相关项目进行分组但无法确定。此外,它的语法非常奇怪-当从它生成文档时它是如何翻译的? 最佳答案 这是一个文档blocktemplate,因此模板之间的每个可记录元素(本例中的每个常量)都具有相同的文档。 关于

php - DocBlock类类型继承

虽然这个问题是关于DocBlocks的一般来说,我的用例是关于PHP的。考虑以下PHP代码:say_hi()->say_b|这只是一个带有一些链接的普通类。扩展类失去了类型提示,因为父类的文档block正在使用不具有子类的方法/属性的特定类名。假设我们确实需要类型提示功能,(如果不需要,请留下这个问题-我不想在这里使用无用的参数),我应该如何解决这个问题?我想到了以下可能性:更改PHPDoc标准以允许使用特殊关键字添加一个多余的say_hi()方法,该方法调用父级只是为了重新声明docblock根本不指定返回类型,让IDE决定return$this;的含义(这是否有效?)

PHP Docblocks - 解释数组

这个问题在这里已经有了答案:关闭9年前。PossibleDuplicate:IsthereawayforphpDoctodocumentanarrayofobjectsasaparameter?我一直在搜索,并查看了phpDocumentor文档,但找不到是否有正确记录将被解析并包含在任何生成的@param数组(如声明预期的键/值类型)的方法文档。这会让我相信没有办法做到这一点,我将不得不使用该描述。提前致谢。

php - 在 PhpDocumentor 2 中使用 @package 而不是命名空间

我有一个大型代码库,我正在尝试为其生成分层文档。该项目不使用命名空间,而是使用@package。我只是尝试使用phpDocumentor2从以下文件生成文档作为测试:虽然根据文档@packageJustAn\Example应该等同于命名空间JustAn\Example,但我发现情况并非如此。当我使用namespace时,生成的文档如下所示:当我使用@package表示法时,结果如下所示(即使它识别包表示法-这显示在类的完整详细信息页面上):我正在寻找一种方法来获得分层结果,而无需重写代码以使用“真实”命名空间。 最佳答案 问题是默认

php - PHP 注释中的符号 "#@+"

我在ZF1的注释/文档中发现了一些特殊符号“#@+”和“#@-”。示例:/**#@+*@accessprotected*/(https://github.com/zendframework/zf1/blob/master/library/Zend/Mail.php#L54)我之前在另一个不同的存储库中看到过。这些是什么意思? 最佳答案 它们是PHPDocBlock模板声明。文件中还应该有一个结束标记/**#@-*/。它允许您跨多个属性、方法或常量指定相同的文档。可以在此处找到更好的示例解释:http://codingexplaine

php - 什么时候应该在 PHPDoc 类型提示和文档 block 中使用 NULL?

在使用PHPDoc描述变量时,我对何时使用null作为类型感到困惑。类型提示是否应该描述外部调用者预期和遵守的希望和期望,或者它们是否应该记录变量的所有可能类型,即使希望它在实践中是一种非常具体的类型?示例1:默认值。以下函数只需要非空值。但如果没有传递任何值,它默认为null并明确检查该值作为确定是否传递任何内容的一种方式,并为该情况返回一个特殊值。希望没有外部调用者会传递除整数以外的任何内容。null应该像下面那样在@param类型中使用,还是应该只指定int因为这是我们想要传递的东西,如果有任何传递的话?/***@paramint|null$bar*/functionfoo($b

php - Doctrine 集合的 Docblocks

在Doctrine项目的docblock注释中,是否有一种标准方法来记录Collection中预期的实体类?像这样的东西:/***@varCollection*/protected$users;看起来PHPDoc现在是docblock注释的实际标准,但我找不到关于这个用例的任何提及。 最佳答案 这是一个解决方案,使您能够在Collection方法和您的objects方法上都有自动完成功能:/***@paramCollection|User[]$users*/publicfunctionfoo($users){$users->//au

php - Doctrine 集合的 Docblocks

在Doctrine项目的docblock注释中,是否有一种标准方法来记录Collection中预期的实体类?像这样的东西:/***@varCollection*/protected$users;看起来PHPDoc现在是docblock注释的实际标准,但我找不到关于这个用例的任何提及。 最佳答案 这是一个解决方案,使您能够在Collection方法和您的objects方法上都有自动完成功能:/***@paramCollection|User[]$users*/publicfunctionfoo($users){$users->//au

php - 如何为方法和属性自定义 NetBeans PHP 自动 DocBlock?

创建方法后,我使用/**生成DocBlock。它会自动填充@param和@return对于那个功能。示例:/****@paramtype$str*@returntype*/publicfunctionstrlen($str){returnstrlen($str);}如何自定义正在生成的block,以便它也填写@author并在/**之后结束/****@paramtype$str*@returntype*@authorJohnDoe*/publicfunctionstrlen($str){returnstrlen($str);}谢谢 最佳答案

php - 如何为方法和属性自定义 NetBeans PHP 自动 DocBlock?

创建方法后,我使用/**生成DocBlock。它会自动填充@param和@return对于那个功能。示例:/****@paramtype$str*@returntype*/publicfunctionstrlen($str){returnstrlen($str);}如何自定义正在生成的block,以便它也填写@author并在/**之后结束/****@paramtype$str*@returntype*@authorJohnDoe*/publicfunctionstrlen($str){returnstrlen($str);}谢谢 最佳答案
12