想象一下,我们有一个带有可选可空参数(PHP7.0)的方法,如本例所示:/***@paramType1$foo*@paramType2$bar*/functionmyFunction(Type1$foo,Type2$bar=null){}不幸的是,从PHPDoc文档中并不清楚,将第二个参数标记为可选和可为空的正确方法是什么。通常我使用“Type2|null”表示法:/***@paramType1$foo*@paramType2|null$bar*/functionmyFunction(Type1$foo,Type2$bar=null){}实际上这是我更喜欢的方式,因为它明确描述了所有可
关闭。这个问题不符合StackOverflowguidelines.它目前不接受答案。要求我们推荐或查找工具、库或最喜欢的场外资源的问题对于StackOverflow来说是偏离主题的,因为它们往往会吸引自以为是的答案和垃圾邮件。相反,describetheproblem以及迄今为止为解决该问题所做的工作。关闭9年前。Improvethisquestion我在thewebsite找到了那个对于这个新手来说是非常压倒性的。有没有更好的教程,它会稍微慢一点,而不是向您扔3个长的php源文件?编辑:真的除了说明书就没有别的了吗???D:
所以,基本上我有以下设置:classA{/***Thisissomedocumentation*/publicfunctionfoo(){}}classBextendsA{/***ThisdocumentationiswaymorespecificthaninclassA*/publicfunctionfoo(){}}当我尝试使用phpDocumentor2对此进行记录时,它在类B的方法foo()中显示“这是一些文档”,但我希望它说“该文档比类A中的文档更具体”。在phpDocumenter1中,一切看起来都像预期的那样。那么,这是怎么回事?这是phpDocumentor2的新默认行为
我有一个大型代码库,我正在尝试为其生成分层文档。该项目不使用命名空间,而是使用@package。我只是尝试使用phpDocumentor2从以下文件生成文档作为测试:虽然根据文档@packageJustAn\Example应该等同于命名空间JustAn\Example,但我发现情况并非如此。当我使用namespace时,生成的文档如下所示:当我使用@package表示法时,结果如下所示(即使它识别包表示法-这显示在类的完整详细信息页面上):我正在寻找一种方法来获得分层结果,而无需重写代码以使用“真实”命名空间。 最佳答案 问题是默认
我最近创建了一个类来创建HTML元素。我没有为每个现有的HTML元素和属性创建一个方法,而是决定使用魔法方法__get和__call。所以用我的代码我基本上可以做到这一点:$signUpForm->insert->input->type('text')->name('firstName')->maxlength(100)->disabled$signUpForm->insert->input->type('email')->name('emailAddress')->maxlength(100)等等但由于我决定保持这种“魔法”和简单,我也可以这样做:$signUpForm->inser
假设我有一个方法,它有一个参数,其有效值被声明为类常量(想想PGSQL_ASSOC/PGSQL_NUM/PGSQL_BOTH)。还有另一种方法,具有类似的参数,使用另一组类常量。有没有办法向phpDocumentor描述每组常量属于一个逻辑组的替代方案?将它们分组记录并能够在方法文档中引用特定组会很有用。使用docblock模板不会削减它,因为模板的简短描述被忽略(添加无用的困惑),而模板的长描述附加到常量特定的描述,导致某种倒退的措辞(例如“BAR_MODE_1does这个和那个。Foo::bar()的操作模式”,而不是“Foo::bar()的操作模式:BAR_MODE_1做这个做那
我正在记录我使用phpDocumentor在PHP中构建的程序。一切正常,但文档显示我有近100个错误,因为它正在读取我用来将文件上传到我的服务器的文件,但我没有创建。是否可以忽略给我所有错误的特定文件?这是我正在执行以生成文档文件的命令:phpdocrun-d/var/www/html/myprogram/-t/var/www/html/myprogram/documentation我试图忽略的文件位于/myprogram目录中,如下所示:/modules/module1/uploader.php我找到了一些关于使用--ignore的信息,但我不知道这是否指的是目录的特定内容。是否可
好吧,我受够了phpDocumentator.它消耗的内存(1.4GB)和时间(在2.6GHzCore2Duo上为5分钟)比我愿意提供的要多得多。是否存在一些真正兼容的程序来为PHP代码生成文档?我试过了PHPDoctor,看起来不错,但它有一些missingfeatures.然而,它可能最接近于我迄今为止尝试过的所有解决方案的替代品。我也试过PhpDocGen,但它只是解决了一些Perl错误,我懒得研究了。Doxygen似乎也不能很好地处理我们的资源。PS:文档适用于phpMyAdmin,有点过时的文档是here.更新:代码包含很多函数而不仅仅是对象,Doxygen最大的问题是什么,
是否可以链接到另一个方法/类/属性/等等。在我的项目内联@deprecated标签内?像这样:/***Methoddescription*@deprecated1.0Reasonfordeprecation,use{@linknewMethod()}instead!*@paramstring$str*@paramstring|null$str2*@returnbool*/publicfunctionmethod($str,$str2){//TODO:Code...}...? 最佳答案 根据PHPdoc.org,您可以使用@see的标
我正在尝试使用phpDocumentor(这是第一次,我不知道自己在做什么)。实际上,我只想将它与SublimeText2和this一起使用插入。你能一步步指导我怎么做才能让它发挥作用吗?这是我现在所做的:(我使用的是Windows7)从here下载phpDocumentor并将其放置在某个地方。我已经为phpdoc/bin创建了系统路径(因此phpdoc.bat可以由sublime插件执行),然后还添加了php的系统路径(来自WAMPserver安装)当我尝试使用我的插件(或在控制台窗口中执行phpdoc)时,我得到这个错误:无法打开输入文件:\phpdoc.php