为不同的访问级别生成 PHP 文档



我正在从事一个需要生成 3 个或更多文档的 php 项目,这些文档比其他文档更严格。 对于文档,我使用 PhpDocumentor 2。 我发现的唯一方法是使用 2 级文档,使用@internal标签和 --parseprivate 选项(用于生成私有文档(。

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

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

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

"中级"是一个相当武断的描述。 这里所有三个"级别"都需要详细说明一些特定的要求,并且最好由三个不同的phpdoc.xml配置文件进行管理。

下面是一个示例,说明我如何描述三个级别的文档,以及如何完成它们。

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

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

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

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

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

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

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

相关内容

  • 没有找到相关文章

最新更新