SeqAn3:依赖项、工具、文档与测试全解析
1. 文档部分
文档是软件项目尤其是库的重要组成部分。为避免 SeqAn1/2 文档工作的不足,SeqAn3 决定使用成熟的 Doxygen 文档生成器。使用 Doxygen 有诸多好处:
- 减少团队工作量 :无需维护自定义文档生成器,使项目更紧凑。
- 降低新贡献者学习成本 :成熟的系统让新贡献者更容易上手。
Doxygen 的多功能性体现在:
- 统一文档位置 :能将 API 文档和详细的教程/操作指南放在同一位置,而 SeqAn1/2 中它们是分开的,且生成需要不同步骤。
- 统一标记语言 :支持 GitHub 风格的 Markdown,使得不同类型的文档和项目交流都使用相同的标记语言,相比 SeqAn1/2 中不同文档使用不同语言编写,这是一个显著的简化。
SeqAn1/2 文档生成器的主要技术问题是缺乏源代码解析,即源代码注释与实际源代码相互独立,无法验证接口文档与实现是否一致。而 Doxygen 有 C++ 解析器,在 SeqAn3 的强模板代码库上工作得很好,可能是因为 SeqAn3 采用了更正统的编码技术,或者是 Doxygen 自身的进步。不过,Doxygen 在处理 SeqAn3 代码时,C++ Concepts 的定义和使用是主要问题,但可以将 SeqAn 的概念定义表示为 Doxygen 的接口,实现与一般文档的良好集成。
在模板定义中使用概念和约束时,中间语法可被 Doxygen 完全接受,详细语法
超级会员免费看
订阅专栏 解锁全文
42

被折叠的 条评论
为什么被折叠?



