问题标签 [apigen]

我很乐意将此作为一般编程问题发布。我不这样做的原因是不同的文档系统处理标签的方式不同，因此对特定语言的“正确”或“错误”施加了自己的规则。

现在有问题的语言是 PHP。到目前为止，它还没有“标准”文档系统。有 phpDocumentor，虽然作为一个项目已经过时，但它似乎已经建立了基础。像 ApiGen 这样的当前产品似乎在努力支持它的语法。

我不太清楚该放在哪里的一个标签是@author 标签。我想把它放在文件级文档块中。连同@copyright、@license、@package 和@link。而不是在类级别的文档块内。对于某些情况：我的 PHP 文件每个只包含一个类声明。

但是，我未能找到支持这一标准的证据。确实很少有信息可以找到应该首选的位置。这让我相信我可能应该在文件级文档块和类一级中包含这些信息。

一些示例：OpenEMR 似乎更喜欢在文件级别块内以及类级别 1 ( http://www.open-emr.org/wiki/index.php/How_to_Document_Your_Code_Properly ) 中使用 @author。该文档没有说明是打算同时发生还是仅在文件不包含类而是包含许多函数时才发生：

然而，ApiGen 引用的两个项目（Doctrine ORM API 和 Nette API）似乎没有在文件级别的文档块中使用@author 标签，而是在类级别的文档块中使用。但是，我在浏览那些包括类声明的地方时看到的唯一例子。

Doctrine 使用 @author 和其他标签，我本来想放在文件级 doc 块中，在类级 doc 块内（http://www.doctrine-project.org/api/orm/2.4/source-class -Doctrine.ORM.AbstractQuery.html#AbstractQuery）：

Nette 虽然也只在类/接口上下文中使用 @author 标签，但似乎根本没有使用 @license @copyright 或 @link：

我正在尝试在不同的类中创建从一种方法到另一种方法的@link。例子：

同一类中的内联 @link 工作正常。但是到另一个类的内联链接不会生成到文档的链接。相反，它会生成：

我做错了什么还是我只是想实现不可能的事情？我查看了 Apigen 文档和他们的论坛（在 GitHub 和 Google Groups 上），但没有任何成功。谢谢你的帮助。

我使用 apigen 从 netbeans 中生成我的 phpdoc。但现在我想在我的 antscript 中使用它。

我已经下载了windows的独立版本。https://github.com/apigen/apigen/downloads最新的 2.8.0 版本。

我的蚂蚁脚本看起来像这样。

mkdir 命令工作正常，但是没有执行 exec 命令……我没有收到任何错误。

我正在尝试在 Windows 上安装Apigen。我正在按照此处提到的说明进行操作。

但是我在cmd中收到以下错误：

我在 Windows 上配置了 ApiGen，并尝试从 NetBeans 生成文档。在许多错误之后一切都运行良好，但是我有一个错误，我的目的地是我的电脑上的桌子。我怎样才能改变这个？每当我尝试生成文档时，它都不会再次询问我的目的地。

我尝试卸载 NetBeans 我又做了一遍，但没有。

我的错误是我的文档的目的地。

我无法在 Mac 上安装 ApiGen。我按照 apigen.org 上的指示做了所有事情：

这就是我每次得到的结果！

有人可以告诉我我做错了什么。

谢谢

我们目前使用ApiGen来记录我们的 PHP 类。在我们的文档注释中，有很多@link这样的内联语句：

运行 ApiGen 时，该语句扩展为这样的链接（请忽略href）：

\NSLevel1\NSLevel2\NSLevel3\AbstractValidatableItem

对于许多内联链接，这会产生几乎不可读的文本。因此，我想要一个只包含简单类、接口或方法名称的链接：

AbstractValidatableItem

有没有办法在不打补丁的情况下使用 ApiGen 做到这一点？我已经试过了

但这似乎破坏了链接的解析。

CLI 在 ApiGen 中排除多个文件夹的正确语法是什么？

我尝试用逗号分隔它们，但这被忽略了（可能读作一条路径）：

我正在尝试运行 APIGen v4，但无法正确解析配置文件。有没有人有一个适用于 APIGen v4 的 APIGen 霓虹灯配置文件的工作示例？