0

我正在一个需要生成 3 个或更多文档的 php 项目中工作,这些文档比其他文档更具限制性。对于文档,我使用 PhpDocumentor 2。我发现的唯一方法是 2 级文档,使用@internaltag 和 --parseprivate 选项(用于生成私有文档)。

是否可以生成具有中间限制级别的第三个文档?

我也尝试过@access使用--visibility 标记,但它在phpDocumentor 的第2 版中不起作用。或@ignore标记,但我没有找到一种方法来生成带有此标记设置的代码的第三个文档。

4

2 回答 2

0

@access标记是一个已失效的 PHP4 标记,在将实际可见性关键字添加到 PHP5 之前使用。PhpDocumentor 1.x 将识别标签,但如果关键字在代码中,标签将被忽略。2.x 甚至不再理会这些标签。

“中级”是一个相当随意的描述。这里的所有三个“级别”都需要阐明一些特定的要求,并且可能最好由三个不同的phpdoc.xml配置文件来管理。

这是我如何描述三个级别的文档以及如何完成它们的示例。

API 级别:我会使用基于文件的参数来仅记录接口。如果@api在 docblocks 中使用标签来表示公共 API 的实际各个部分,那么您可以只依赖它们。但是,我认为文档中此信息的呈现实际上只是一个突出显示的侧边栏,而我专门记录接口的方法意味着整个文档只是定义的接口(我认为是“API”)。

应用程序级:我会捕获所有类,但使用仅显示公共可见性组件的默认行为。

开发级:我会使用 --parseprivate 来显示所有组件。我自己也倾向于将面向开发人员的信息放入@internal标签中。

同样,我会phpdoc.xml为每一个使用定制的配置文件,以便我的定义可以提交给版本控制。

于 2017-07-28T19:14:10.547 回答
0

这是一个有趣的问题/问题。为特定用户定制文档的能力。

我会检查PHPFUI/InstaDoc。我写它是因为我对 PHP 文档的当前状态不满意。它是一个动态文档查看器。它非常适合开发 PHP 应用程序,因为您拥有当时实际编写的新代码的所有当前文档,以及所有旧代码,包括通过 Composer 引入的代码。它读取当前文件的文档块并动态呈现文档。因此,在您签入代码之前,您实际上可以看到您包含的文档。经常查看文档,您会发现可以修复的问题和事情。因此,它提供了一个很棒的工作流程。

可以很容易地使其具有访问级别。检查它并提交问题或 PR,添加用户可控视图非常简单。但是您的问题正是创建 InstaDoc 的目的。希望对你有帮助。

于 2020-01-20T02:03:09.037 回答