草庐IT

phpDocumentor

全部标签

PHP Docblock #@+ 含义

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

php - 使 PHPdoc 包含 CakePHP .ctp 文件

我正在使用PHPdocumentor记录我的CakePHP应用程序.您可能知道,在CakePHP约定之后,View包含在.ctp文件中(例如app/views/addresses/index.ctp),这些文件基本上是普通的PHP文件,只是文件扩展名发生了变化。PHPdocumentor只识别.php文件,我在配置文件中找不到一个选项让它知道.ctp文件。这部分最接近我想要的:;;comma-separatedlistoffilestoparse;;legalvalues:pathsseparatedbycommas;filename=/path/to/file1,/path/to/f

php - 这些 PHPDOC 属性的用途是什么?

一般来说,PHPDOC属性是不言自明的,但我很难理解这些属性:@category-这到底是什么?@package-有人可以提供有关此属性用法的示例吗? 最佳答案 包标签是您在代码中使用的关键组织标签。当phpDocumentor生成文档时,它会将元素收集到您设置的包中。在某些情况下,您可能会选择对整个代码库只使用一个包名称(@packageMyPackage),这样所有文件、类等都会出现在该包的文档中。但是,如果您选择更模块化地组织事物,您可以将所有面向Web的过程文件放在一个包中(@packageWebpages),将所有面向数据

php - 无法将 detect_unicode 设置/找到为关闭

我想开始使用phpDocumentor,但手动安装一直抛出错误,提示我没有在终端的php.ini中设置detect_unicode=Off。当我将它添加到我的php.ini时,它没有用,我在运行安装时遇到了同样的问题。似乎没有人遇到过这个问题,而且我这辈子都弄不明白。https://github.com/phpDocumentor/phpDocumentor2/blob/develop/README.md#installation我错过了什么?(我确实在php.ini编辑后重启了MAMP服务器)终端错误的屏幕截图... 最佳答案 如

php文档: document only classes

我正在尝试了解phpDocumentor。我通常为每个文件放一个类。我是否被迫记录文件和类(class)?我只想记录类(我为什么要记录文件?)但我收到警告...WARNINGincomment.class.phponline8:DocBlockwouldbepage-level,butprecedesclass"Comment",useanotherDocBlocktodocumentthefile我读过http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.quic

php - 简单的破旧,全面的 phpDocumentor 教程?

关闭。这个问题不符合StackOverflowguidelines.它目前不接受答案。要求我们推荐或查找工具、库或最喜欢的场外资源的问题对于StackOverflow来说是偏离主题的,因为它们往往会吸引自以为是的答案和垃圾邮件。相反,describetheproblem以及迄今为止为解决该问题所做的工作。关闭9年前。Improvethisquestion我在thewebsite找到了那个对于这个新手来说是非常压倒性的。有没有更好的教程,它会稍微慢一点,而不是向您扔3个长的php源文件?编辑:真的除了说明书就没有别的了吗???D:

phpDocumentor 不会覆盖父类的文档

所以,基本上我有以下设置:classA{/***Thisissomedocumentation*/publicfunctionfoo(){}}classBextendsA{/***ThisdocumentationiswaymorespecificthaninclassA*/publicfunctionfoo(){}}当我尝试使用phpDocumentor2对此进行记录时,它在类B的方法foo()中显示“这是一些文档”,但我希望它说“该文档比类A中的文档更具体”。在phpDocumenter1中,一切看起来都像预期的那样。那么,这是怎么回事?这是phpDocumentor2的新默认行为

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

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

php - 使用 phpDocumentor 记录类常量组

假设我有一个方法,它有一个参数,其有效值被声明为类常量(想想PGSQL_ASSOC/PGSQL_NUM/PGSQL_BOTH)。还有另一种方法,具有类似的参数,使用另一组类常量。有没有办法向phpDocumentor描述每组常量属于一个逻辑组的替代方案?将它们分组记录并能够在方法文档中引用特定组会很有用。使用docblock模板不会削减它,因为模板的简短描述被忽略(添加无用的困惑),而模板的长描述附加到常量特定的描述,导致某种倒退的措辞(例如“BAR_MODE_1does这个和那个。Foo::bar()的操作模式”,而不是“Foo::bar()的操作模式:BAR_MODE_1做这个做那

php - 我如何忽略 phpDocumentor 中的特定文件

我正在记录我使用phpDocumentor在PHP中构建的程序。一切正常,但文档显示我有近100个错误,因为它正在读取我用来将文件上传到我的服务器的文件,但我没有创建。是否可以忽略给我所有错误的特定文件?这是我正在执行以生成文档文件的命令:phpdocrun-d/var/www/html/myprogram/-t/var/www/html/myprogram/documentation我试图忽略的文件位于/myprogram目录中,如下所示:/modules/module1/uploader.php我找到了一些关于使用--ignore的信息,但我不知道这是否指的是目录的特定内容。是否可