问题标签 [phpdoc]

我有许多变量的对象，我在评论中声明和解释。我非常彻底地评论了以后使用 phpDoc 进行处理，但是我还没有实际编译文档的经验。

我发现使用 phpDoc 表示法非常烦人，即使我要设置的唯一属性是描述，每个变量也会占用四到六行代码：

我想使用以下符号：

有没有一种简单的方法可以调整 phpDoc 以接受它，或者当我实际尝试从中编译文档时它会给我带来麻烦？我现在不需要调整（尽管它当然值得赞赏），只是来自知道 phpDoc 的人的声明，这是否可行，而无需重新设计其大部分代码。

在 Zend Framework（或其扩展）等框架中，有时可以使用 PHPDoc 样式注释将类型提示等信息传递给框架代码。

我无法想象框架使用 PHP 解析文件，但我没有看到任何其他方法来实现这一点，除了 PHP 的一些内置语言功能，我不知道。那么这是怎么做到的呢？

一般来说，PHPDOC 属性是不言自明的，但我很难理解这些：

@category- 这到底是什么？

@package- 有人可以提供有关此属性使用的示例吗？

我最近一直在玩 phpDocumentor，发现它非常适合我的需求。我主要使用 PHP/HTML/JS/CSS 代码库，并希望 phpDocumentor 解析我的 Javascript（可能还有 CSS）以便将它们保持在一起。

我已经设法让 phpdoc 解析整个代码库中包含的 javascript 文件 - 但是它拒绝页面级 docblock - 这导致它拒绝各种标签（见下文）。我发现通过在 JavaScript 文件的顶部添加一个 PHP 打开标记（前面有一个 JavaScript 注释），我可以让它像解析 PHP 文件一样解析它。

如果通过 PHP 将网络服务器设置为服务器 .js 文件，我可以想到会出现问题。还有其他任何人可以想到的问题吗？有没有更好的方法来实现这一点？

谢谢

只是好奇netbeans中是否有办法为常规变量提供类型提示，以便智能感知将其拾取。我知道您可以对类属性、函数参数、返回类型等执行此操作，但我不知道如何对常规变量执行此操作。在您拥有可以返回不同对象类型的方法（例如服务定位器）的情况下，这将非常有用。

例如：

在之后使用 $someService 的地方，netbeans 将提供在 Some_Service 类中定义的所有可用方法。

我有几个已完成的较旧的 PHP 项目，其中包含很多我想以 javadoc/phpDocumentor 样式记录的内容。

虽然手动处理每个文件并被迫与文档一起进行代码审查将是最好的事情，但我只是出于时间限制，对帮助我尽可能自动化任务的工具感兴趣。

我正在考虑的工具理想地具有以下功能：

• 解析 PHP 项目树并告诉我哪里有未记录的文件、类和函数/方法（即缺少适当的 docblock 注释的元素）

• 提供一种方法，通过创建空结构并在理想情况下在编辑器中打开文件（我不在乎内部或外部）中轻松添加缺少的文档块，以便我可以放入描述中。

选修的：

• 自动识别参数类型、返回值等。但这并不是真正需要的。

有问题的语言是 PHP，尽管我可以想象 C/Java 工具经过一些调整后可能能够处理 PHP 文件。

感谢您的大力投入！

我在让 phpdoc 正确运行时遇到了一些问题。大部分文档都已成功生成，但我多次收到以下警告：

警告：date ()：依赖系统的时区设置是不安全的。您需要使用 date.timezone 设置或 date_default_timezone_set() 函数。如果您使用了这些方法中的任何一种，但仍然收到此警告，您很可能拼错了时区标识符。我们America/Los_Angeles在第 5064 行的 /Users/ben/bin/PhpDocumentor/phpDocumentor/Converter.inc 中为 'PST/-8.0/no DST' 选择了 ' '

和

警告：strftime ()：依赖系统的时区设置是不安全的。您需要使用 date.timezone 设置或 date_default_timezone_set() 函数。如果您使用了这些方法中的任何一种，但仍然收到此警告，您很可能拼错了时区标识符。我们America/Los_Angeles在第 370 行的 PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php 中为 'PST/-8.0/no DST' 选择了 ' '

我可以轻松地从代码中删除 Smarty 警告，因为它只是在渲染文档的模板顶部生成时间戳。没什么大不了的。phpDocumentor 中的第一个错误我不确定。似乎只是为模板分配了一个日期给 Smarty：

也许我可以删除 Smarty 模板和这一行中的所有“日期”变量。

无论如何，这个警告也在生成的文档中，并且索引页面只显示这个警告。有什么想法吗？我使用的是 1.4.3 版本，这是我的标志/选项：

我需要一个 PHP 项目的文档系统，并且我希望它能够将外部文档（用例、项目范围等）与从代码注释生成的文档集成。似乎 phpDocumentor 具有完全正确的功能集，但外部文档必须用 DocBook 编写，这对我们的团队来说太复杂了。

如果它在 python 中，sphinx 将非常适合这项工作（ReST 绝对比 docbook 简单）。有什么方法可以将外部 ReST 文档与从 phpdoc 中提取的文档集成在一起？我是否应该将外部文档分开（例如，将 ReST 用于外部，将 phpdoc 用于内部）？或者您对管理外部文档有更好的建议吗？

我有这个带有可选参数的构造函数。主要问题是可用性。使用我的框架的开发人员会立即感到头疼，因为他不知道他是否可以提供论据，什么样的论据，或者他是否根本不能。结论：简直糟透了。但是如果有人安装了像 Netbeans 这样的合理 IDE，PHPDoc 可能会有所帮助；）

所以：

我怎么能在这里使用 PHPDoc 来表明可以提供一个可选的 [$tpl] 参数？

我无法找到可以用 PHPDoc 提示的类型的概述。我知道数组或字符串，但也有 bool 吗？喜欢：