在 Git 工作流中生成 API 文档

10

不确定这个问题应该放在这里还是Programmers上。

生成API文档

我想请教一下如何为一个内部项目生成API文档。我对Git相对陌生,我们正在尝试实现一些可靠的构建/部署实践。

我们讨论的其中一件事是确保我们的代码库有很好的文档,并使用类似PhpDocumentor2或其他许多类似工具生成文档。

我们已经开始实施类似于here详细介绍的工作流程。


我应该在文档生成时自动化吗?

例如,在标记发布版本时,使用git的预或后提交挂钩。还是当我将develop合并到发布分支时,只需手动创建文档并提交到存储库中?

每个发布版本都生成文档是标准做法吗?

我可能误解了这个过程,新的文档发布是否应与git发布/标记相关联?

您在哪里存储生成的文档?

在同一存储库中?不同的存储库?托管在Read The Docs之类的地方还是仅在内部?我们正在处理的当前项目很小,但如果成功,我们希望将该流程推广到其他更大的项目中。

背景

该项目是Magento扩展程序,我们希望提供API文档、单元测试和符合PSR的代码。我缺乏有关整个工作流程如何集成的信息。通过Composer本地安装了PHPunit和PHPDocumentor2。

我听说过Travis Ci,并查看了它,但我不确定文档是否属于那个类别。

这个问题可能看起来琐碎或微不足道,但我在集成和git工作流程方面经验不多,而且我找不到太多信息。

1个回答

2

生成的文档通常有以下特点:

  • 始终与代码源保持同步(因此“新文档发布是否应与git发布/标记相关”这个问题变得无关紧要)
  • 不存储在版本控制引用中(如git repo),而是可以随意(重新)生成(在任何您喜欢的位置)。

如果您查看一个具有大量代码源和广泛代码文档的项目,可以以Go语言他的存储库为例(一个mercurial repo,但您也可以在GitHub上找到镜像


我也是这么想的,只是想要一些澄清。由于这只是一个小型内部项目,我认为如果他们需要生成文档,我会把它留给拉取该项目的人!感谢您的回答。 - Aydin Hassan

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接