开源项目推荐：Adobe Hyde

开源项目推荐：Adobe Hyde

hyde A front-end to Jekyll that parses C++ sources to produce and enforce out-of-line documentation 项目地址: https://gitcode.com/gh_mirrors/hyde1/hyde

项目基础介绍和主要编程语言

Adobe Hyde 是一个基于 Jekyll 的前端工具，专门用于解析 C++ 源代码，生成并强制执行外部文档。该项目的主要编程语言是 C++，并且它利用了 Clang 的 libTooling 库来实现对 C++ 代码的解析和处理。

项目核心功能

1. Clang 基础：Hyde 使用 Clang 的 libTooling 库来编译 C++ 代码，确保随着 C++ 语言的发展，Hyde 也能同步更新，保持对最新 C++ 特性的支持。

2. 外部文档生成：与许多依赖于源代码内联注释的文档工具不同，Hyde 生成的是外部文档，避免了注释与代码不同步的问题，同时也减少了代码中的注释干扰。

3. Jekyll 兼容：生成的文档是结构化的 Markdown 文件，包含 YAML 前言，这些文件可以被 Jekyll 等静态站点生成工具消费，以定制文档的结构和布局。

4. 模式强制：Hyde 能够将现有文档文件与当前的 C++ 源代码状态进行比较，开发者可以使用 Hyde 的更新模式来更新文档，而构建工程师可以使用验证模式来确保代码库的更改准确反映在最新文档中。

5. 可适应性：除了生成和强制文档外，Hyde 还可以输出基于 AST 的代码信息作为 JSON 格式的 IR，为构建其他工具提供了可能性。

项目最近更新的功能

1. Hyde 2 格式转换：引入了 Hyde 2 格式，所有子字段（除了 Jekyll 所需的布局和标题字段）必须放在顶级 hyde 子字段下，这允许其他工具在 YAML 中包含额外的（可能同名的）字段。

2. 子字段修复模式：新增了 -hyde-fixup-subfield 模式，用于将旧版 Hyde 1 格式的文档转换为 Hyde 2 格式。

3. Sass 文件更新：增加了对 Sass 文件的清理和“lint”功能，可以通过 bundle exec sass-convert -i 命令来实现。

通过这些更新，Hyde 不仅提升了文档生成的灵活性和准确性，还增强了与其他工具的兼容性，使其成为一个更加强大和全面的 C++ 文档工具。

hyde A front-end to Jekyll that parses C++ sources to produce and enforce out-of-line documentation 项目地址: https://gitcode.com/gh_mirrors/hyde1/hyde