问题标签 [phpdoc]

我用 C 编写了一个 PHP 扩展，我想创建PHPdoc文档，以便我的用户在调用我的扩展时可以在他们的 PHP IDE（在本例中为 Netbeans）中获得内联文档。

理想情况下，我想通过在 C 代码中嵌入 PHPdocs 来做到这一点，以将实现和文档保持在一起。

假设可以将 PHPdocs 嵌入到 C 中，需要哪些额外步骤才能使文档出现在 Netbeans 中（就像 PHP 代码的 PHPdocs 一样）？

编辑：

O'Reilly Programming PHP指的是/* {{{ proto文档生成中使用的注释格式，但我不确定所引用的脚本是否生成 PHPdocs：

{{{ proto 行不仅用于在编辑器中折叠，而且还被 PHP 文档项目中的 genfunclist 和 genfuncsummary 脚本解析。如果您永远不会分发您的扩展并且没有将其与 PHP 捆绑在一起的野心，您可以删除这些评论。

在这个例子中：

如何表明 $foo 必须属于 Foo 类？

我正在使用 Eclipse + PDT 进行开发。我一直在我的代码中添加 phpdoc 注释，但实际上从未在 Eclipse 中生成结果文档。我应该怎么做 - Eclipse 中是否有一些功能，或者文档生成应该在外部完成？

在我的第一次尝试中，我只包含了系统/应用程序/模型、系统/应用程序/控制器、系统/应用程序/助手和系统/应用程序/库。我选择这些文件夹是因为我认为这些文件夹包含您希望正确记录以供将来参考的代码。您认为应该包括哪些其他文件夹？

Is there anything similar to netbean's Javadoc auto comment tool for PHP/phpDocumentor/Eclipse? In the netbeans implementation:

A dialog pops up and allows you to run through all the members of your class and enter comments, which are added to the source file. It even verifies that there are no parameters you have not accounted for, so you can be sure that your comments are complete.

Ideally this would be standalone software, but plugins are OK too :)

p.s. netbeans 6+ auto comment was moved/renamed. Now in "Tool->Options", Tab: "Java Code", Javadoc: "Hints"

edit: screengrab of the original Netbeans tool:
_{(source: vsj.co.uk)}

我正在尽一切努力让 phpdocumentor 允许我使用 DocBook 教程格式来补充它创建的文档：

1. 我正在使用 Eclipse
2. 我已经通过 PEAR 在 OSX 机器上安装了 phpDocumentor
3. 我可以从我的 php 类运行并自动生成代码
4. 它不会格式化教程 - 我找不到解决方案

我已经尝试将 .pkg 示例文件移动到整个文件结构中，在子文件夹中使用与代码中引用的包相似的名称.. 我真的很茫然 - 如果有人可以解释他们放置的位置.pkg 和其他 DocBook 文件与他们正在记录的代码以及它们如何触发 phpdoc 对其进行格式化有关，我将不胜感激，我目前正在使用它：

可能重复：
是否有记录 GET/POST 参数的标准？

试图找出通过 phpdoc 以有意义的方式记录请求参数的最佳方法。具体来说，我有一些 Zend Framework 控制器操作，它们通过 GET/POST 接收参数，但不是功能参数。这有意义吗？

如果我为此方法生成文档，则不会有迹象表明“order”和“dir”可以通过 url 字符串传递给该方法。这样做会更有意义吗

我应该改用@var 吗？

欢迎提出想法。

对于我的第一个开源项目（无耻插件：mtChart），我目前有两种不同类型的文档：

• Doxygen 从代码中的 phpdoc-comments 生成的 HTML 文件
• Google Code 上的 wiki 页面（或者简单地说：附加文本文件）

Doxygen 文件真的很棒，但我错过了添加“高级”文档的可能性：教程、示例、系统概述、路线图等。

如何以自动方式将这两者结合起来，以便我可以以某种方式自动更新代码文档，包括其余文本？

（如有必要，我愿意离开 Doxygen。）

我看到一些 PHP 函数在顶部被注释，使用我不知道的格式：

我的 IDE 为我提供了 @param 和 @return 之类的下拉选项，因此必须在某处记录它。我试过搜索谷歌，但它不会在搜索中包含 @ 符号。

这种评论格式是什么，我在哪里可以找到有关它的一些信息？

假设我有一个名为Color的 PHP 类，它的构造函数接受各种参数。

我应该如何使用 phpDoc 为构造函数和其他类似方法创建 API 文档？

如何使用带有重载方法的phpDoc？