开发人员指南#

这组页面包含相关的指南、说明和解释GROMACS开发。实际代码记录在Doxygen中文档链接如下。

重点是(至少现在是)与代码紧密相关的东西本身,例如驻留在源存储库中的helper脚本和组织代码本身,并可能要求文档同步更新。

该指南目前分为几个主要部分:

  • GROMACS代码库概述。

  • 描述一些重要实现的概述页面集合方面。

  • 开发GROMACS时要遵循的通用指南。对于一些指导原则,存在脚本(见下文)以自动重新格式化代码和/或强制执行每次提交的准则。

  • 关于使用什么工具以及如何使用这些工具的说明。

除此之外,从注释中提取了Doxygen文档在C/C++中,可以使用代码来记录实际的现有代码。

一些与实际C/C++代码密切相关的概述文档显示在Doxygen文档中,而其他一些概述内容位于开发人员指南。部分原因是技术性的,但交联在开发人员指南和Doxygen文档之间相关内容似乎在两个来源之间分裂。

该文档尚未涵盖所有领域,但正在提供更多内容(慢慢地)添加。

Doxygen文档#

  • 公共API文档

    其中包含显示在已安装标头中的代码的文档,以及一些概述文档,以了解代码。请注意,公共API的定义非常初步并可能发生变化,特别是对于尚未记录在案。

  • 代码文档

    它包含作为子集的公共API文档,但也包含更多GROMACS内部实施的详细信息。这是一个很好的开始理解代码的某些特定区域的地方例如,贡献。

  • 完整文档

    它包含了代码库中的每个单独的文档功能,包括内部可能有大量的细节,但如果试图在代码库。