草庐IT

Docblock

全部标签

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 - 在 Aptana Studio 中为方法生成 DocBlock

我正在使用AptanaStudio3进行PHP开发。我知道有一个用于为类和方法生成PHPDocblock的代码段(键入doc,按ctrl+space并插入适当的代码段)。问题是它只能用于新方法,doc_f片段插入如下内容:/***undocumentedfunction**@returnvoid*@author*/functionfunctionName(){}所以每当我有一个方法要记录时,我仍然必须手动插入所有关于参数和返回值的数据。我记得很久以前我在PDT(Eclipse)中使用过一个方便的热键(ctrl+shift+jIIRC),它会自动为选定的元素填充所有那些PHPDoc参数,

php - 如何在没有自动 DocBlock 格式的情况下在 NetBeans 中进行多行注释?

有时在我的代码中我喜欢注释掉一段代码以供临时使用/引用等,例如:/*blah*/但有个小烦恼是,如果我想在该block中插入一行,当我单击enter时,它会自动在下一行放置一个*,就好像我在做DocBlock一样。这发生在每个回车键上:/*blah**/现在我认为这种“自动格式化”应该只在开场评论使用格式/**(两颗星)时发生。多行注释在DocBlocks出现之前很久就已经存在了,所以我不确定为什么它会强制这些“老派”标准直截了当/**/注释具有不需要的额外DocBlock*!那么有没有办法:a)理想情况下-仅当开始标记为/**时才进行格式化b)或者如果它不能区分/*和/**,是否有办

php - 有没有我可以用来表示实例化后添加的魔术方法属性的 PHP DocBlock?

我正在将PHP对象发送到模板文件,并且希望在我的模板文件的顶部记录对象的哪些属性(使用__get)可用以及它们是什么,并使它们可用于代码提示。这是一个例子。在我的Controller中:$obj=newTemplate("welcomePage");$obj->title="Welcome!";$obj->render();在我的View/模板中:titlestringThepageheadertext/*?>title;?>是否有类似的东西可以工作?如果我开始输入$obj->,我现在拥有的方式不会自动完成,这意味着我(或团队成员)需要引用模板的顶部来查找每个可用属性。我正在考虑为每个

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);}谢谢 最佳答案

php - 是否有可用的 PHP DocBlock 解析器工具?

关闭。这个问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提问寻求书籍、工具、软件库等的推荐。您可以编辑问题,以便用事实和引用来回答。关闭4年前。Improvethisquestion我想为几个项目构建一些规模较小但高度定制的文档站点。PhpDocumentor非常好,但很重。我曾考虑尝试为此调整模板,但在只花了几分钟研究之后,我认为这工作量太大。理想情况下,我希望看到一些东西,我可以将一堆文件传递给它,并让它返回所有文件、类、属性和方法,以及它们的元数据,这样我就可以构建一些简单的模板基于数据。是否有任何仅DocBlock解析器的项目可以帮助我完

php - 如何将 PHP 代码块放入 PHPDoc DocBlock

我正在使用PHPDoc,并意识到您可以使用markdown向DocBlock添加一些格式。特别是,我注意到您可以使用反引号来突出显示内联代码。但是,我似乎不知道如何将代码块添加到DocBlock,因为使用4个空格似乎不起作用。我尝试过使用和同样,虽然这些标签确实出现在生成的文档中,但其中的代码会被HTML注释注释掉。例如,这个DocBlock:/***ThisisatestDocBlock******@returnobject[]Anarrayofobjects.*/生成此HTML:我哪里错了?如何将代码块添加到我的DocBlock? 最佳答案

关于 php:PHPDocumentor – 我的 DocBlock 出了什么问题?

PHPDocumentor-what'swrongwithmyDocBlock?我在一些遗留代码中添加了一些注释,我遇到了PHPDocumentor的一个小问题。这是一个例子:1234567891011121314151617/** *ConstructstheWidgetobject * *Basicconstructorforthewidgetobject. *Anotherlineofpointlessexplanation,badlyworded. * *@param string $id  TheIDofthewidget *@param int   $size TheSizeoft
12