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

我目前正在评估Flyway软件作为我们公司的部署选项。我们在Oracle数据库上运行数据库部署，并目前从SQLPLUS会话中启用输出，以进行记录。我们使用它来验证反馈信息，例如成功创建的对象，包括软件包和功能等。没有错误，验证输入的记录数量等。Flyway中是否有类似的记录功能？当前，我们发现的唯一记录是在服务器日志中。我们可以从这些日志中分辨出脚本已成功完成或触发了ORA错误，但是我们很好奇这是否是数据库记录选项的范围。谢谢，看答案我们使用命令行方法来运行飞速并打开调试输出（-X）。除了许多其他输出外，它还记录了有关SQL迁移运行（例如可重复迁移的内容）和受影响的记录的更多信息。这并不完美，

这个问题在这里已经有了答案:PHPDocforvariable-lengtharraysofarguments(7个答案)关闭4年前。当数组元素作为方法的参数时，记录数组元素的最佳方式是什么？例如，使用PHPDocheader，我可能有类似的内容:@paramarray$data这没有告诉我数组中哪些元素是必需元素，哪些元素是可选元素。我想这应该放在方法的解释中。像这样的东西:array:$data============int$idRequiredname$stringRequiredtown$stringOptional

一直在php中看到这些header注释，经常想是不是用什么软件设置的？我好像记得JavaDoc什么的？但我不确定这是否是自动生成的？或者这只是某种类型的文档标准？下面的例子来自CodeIgniter:/***CodeIgniter**AnopensourceapplicationdevelopmentframeworkforPHP4.3.2ornewer**@packageCodeIgniter*@authorExpressionEngineDevTeam*@copyrightCopyright(c)2008,EllisLab,Inc.*@licensehttp://codeignit

关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题？更新问题，以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我今天第一次尝试使用PHPDoc，很快就遇到了问题。对于每1行变量声明，我至少有5行注释。示例:/***Holdspaththeremoteserver*@name...*@global...*/$myvar=...当然，返回不错-但这会将10行的配置文件变成60行的文件。我花了很长时间才填满，而且我还不相信它比简单的一行增加了那么多。它还会给我的工作流程带来麻烦。一切都很好，直到我需要进

我注意到很多可用的codeigniter库使用与主要用户指南相同的文档样式(例如ion_authhttp://benedmunds.com/ion_auth/)。是否有某种自动化方法可以从源代码注释创建它，或者人们只是使用剪切和粘贴？ 最佳答案 他们实际上在用户指南中有关于编写CIdocumentation:的信息 关于php-如何编写codeigniter文档，我们在StackOverflow上找到一个类似的问题： https://stackoverflow

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

我正在使用Doxygen(DoxywizardGUI)来记录一个PHP项目。Doxygen没有记录我的非类文件。即在一些文件中，我没有创建任何类，该文件只包含一些函数。Doxygen没有记录这些功能。有帮助吗？这是configfileDoxywizard为我生成 最佳答案 您是否在文件中放置了包含@file命令的注释block？另见http://www.doxygen.org/docblocks.html#structuralcommands(以“让我们重复一遍，因为它经常被忽视”开头的段落)

关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题？更新问题，以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我不敢相信通常会有人反对文档和评论，但是在PHP中这样做的最佳实践(和实践)是什么？在JavaScript中，您可以记录您的代码，然后运行一个最小化程序来生成您的代码的生产版本以供使用。在PHP中，额外的文本行会影响性能吗？您是否应该将文档保存在另一个文件中(我认为这对API和框架可能很重要，但会减慢您的开发速度)？编辑:我的逻辑是，它必然会花费更长的时间，因为文件的大小更长，并且为解析器

我正在使用NelmioApiDocBundle连同用于RESTAPI的PHP框架Symfony3。我想在/api/doc页面中显示我的参数的描述。如果不手动添加参数，这可能吗？我想从输入/输出类中导入它。这是我的文档的样子:这是生成文档的Controller操作(/api/user/login)的@ApiDoc:*@ApiDoc(*section="user",*resource=true,*description="Checkstheusercredentialsandreturnsanauthentication&refreshtokeniftheyarecorrect",*inp