gpt4 book ai didi

c++ - Doxygen 用于使用 git 管理的项目?

转载 作者:IT老高 更新时间:2023-10-28 21:40:37 31 4
gpt4 key购买 nike

我正在开发一个 C++ 和 Objective C iPhone 项目。我使用 git 作为我的版本控制系统。

代码库已经增长了很多,所以我想添加 doxygen到项目。问题是我不确定什么是最好的方法。

我考虑了几个选项:

1) 在项目文件夹中创建 doxygen HTML 文档,并使其成为项目的“一部分”,以便它也被版本化并提交给 git。

2) 在项目文件夹中创建 doxygen HTML 文档并将其添加到 .gitignore 以便项目的每个用户负责生成文档并且项目 git 存储库将保持不变(除了对于 .gitignore)。

我们在主服务器中使用 git --bare 存储库,因此在服务器中挂载包含 HTML doxygen 的网页会很复杂(您实际上无法使用 git --bare 存储库查看项目文件,所以除非我单独上传,否则我将无法看到 doxygen 生成的 HTML 文档)

也许我可以制作某种 cron-job,以保持服务器端的 doxygen 更新?

非常欢迎帮助。

最佳答案

我认为永远不应该将生成的文件存储在源存储库中,尤其是当它们是由诸如 Doxygen 等常用工具从已存储在存储库中的文件中生成时。对于 Doxygen,您只需将 Doxyfile 存储在 repo 中即可。

(或者,如果您使用 autoconf 更好,请存储 Doxyfile.in,以便将当前项目版本号替换为生成的 Doxyfile 配置步骤的一部分。)

如果您想确保每个 checkout 您的项目的人都能获得一份 Doxygen 生成的引用手册,请将其作为默认构建过程的一部分。

关于c++ - Doxygen 用于使用 git 管理的项目?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/3528193/

31 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com