sourcedocs for Mac 版
从内联源代码文档生成 Markdown 文件
sourcedocs 是什么
SourceDocs 是一个命令行工具,用于从源码中的内联注释生成 Markdown 格式的文档。它面向 Swift 开发者,能够解析 Xcode 项目或 Swift Package,提取其中的公开类型信息,自动生成参考文档。与 Sphinx、Jazzy 等工具不同的是,SourceDocs 输出的是 Markdown 文件,可以直接存放在项目仓库中随代码一起浏览,也可以借助 GitHub Pages 渲染成网页。
核心功能包括:从 Xcode 项目生成参考文档、从 Swift Package 生成参考文档,以及为 Swift Package 生成包描述文档。生成的文档默认写入项目根目录下的 Documentation/Reference 路径(可配置),因此能与手写文档放在一起管理。工具建议将生成结果提交到代码仓库,GitHub、BitBucket 等平台对 Markdown 的渲染效果良好,阅读起来很方便。
使用时,在 Swift Package 根目录运行 sourcedocs generate --all-modules 可为所有模块生成文档,也可通过 --spm-module 指定单个模块;在 Xcode 项目根目录直接运行 sourcedocs generate 即可,通常无需额外参数,必要时可传入 scheme 等 xcodebuild 参数。它适合希望以轻量方式维护 Swift 项目 API 文档、并让文档随代码内联浏览的开发者。
核心功能包括:从 Xcode 项目生成参考文档、从 Swift Package 生成参考文档,以及为 Swift Package 生成包描述文档。生成的文档默认写入项目根目录下的 Documentation/Reference 路径(可配置),因此能与手写文档放在一起管理。工具建议将生成结果提交到代码仓库,GitHub、BitBucket 等平台对 Markdown 的渲染效果良好,阅读起来很方便。
使用时,在 Swift Package 根目录运行 sourcedocs generate --all-modules 可为所有模块生成文档,也可通过 --spm-module 指定单个模块;在 Xcode 项目根目录直接运行 sourcedocs generate 即可,通常无需额外参数,必要时可传入 scheme 等 xcodebuild 参数。它适合希望以轻量方式维护 Swift 项目 API 文档、并让文档随代码内联浏览的开发者。
如何安装 sourcedocs
- 打开 终端(按 ⌘ + 空格,输入“终端”)。
- 如果还没安装 Homebrew,先运行下面这条安装命令。
- 运行下面这条命令:
最近 10 个版本记录
最近一次更新为 2022-04-02,当前版本 2.0.1,共记录最近 10 个版本。
| 版本 | 发布日期 | 类型 | 大小 | macOS | Windows | Linux |
|---|---|---|---|---|---|---|
| 2.0.1 | 2022-04-02 | 稳定版 | — | — | — | — |
| 2.0.0 | 2021-11-29 | 稳定版 | 1.3 MB | 下载 | — | — |
| 1.2.1 | 2020-07-31 | 稳定版 | 3.4 MB | 下载 | — | — |
| 1.2.0 | 2020-06-04 | 稳定版 | 3.4 MB | 下载 | — | — |
| 1.1.0 | 2020-05-27 | 稳定版 | 3.4 MB | 下载 | — | — |
| 1.0.0 | 2020-05-11 | 稳定版 | 2.9 MB | 下载 | — | — |
| 0.6.1 | 2019-11-03 | 稳定版 | 904 KB | 下载 | — | — |
| 0.6.0 | 2019-11-01 | 稳定版 | 904 KB | 下载 | — | — |
| 0.5.1 | 2018-09-26 | 稳定版 | 3.8 MB | 下载 | — | — |
| 0.5.0 | 2017-11-14 | 稳定版 | 3.8 MB | 下载 | — | — |
数据来自 GitHub Releases,稳定版优先,同类按发布时间排序。
二进制包支持平台
Homebrew 官方提供的预编译包(bottle)覆盖:
- Apple 芯片 · 最新 macOS
- Apple 芯片 · macOS 26 Tahoe
- Apple 芯片 · macOS 15 Sequoia
- Apple 芯片 · macOS 14 Sonoma
- Intel · macOS 14 Sonoma
- Linux · ARM64
- Linux · x86_64
与同类应用对比
只对比公开元数据,不做主观推荐;需要逐项对比时见对比页。
| 应用 | 版本 | 许可证 | 架构 | 近 30 天安装 |
|---|---|---|---|---|
| sourcedocs | 2.0.1 | MIT | 命令行 | 4 |
| jsrepo | 3.8.2 | MIT | 命令行 | 7 |
| pod2man | 6.1.1 | Artistic-1.0-Perl OR GPL-1.0-or-later | 命令行 | 7 |
| codevis | v0.8.4 | MIT | 命令行 | 7 |
命令行工具中的类似应用
jsrepo
jsrepo 是一个面向现代开发者的命令行工具,核心用途是帮你构建并分发自己的代码。pod2man
pod2man 是一个把 Perl 的 POD 文档格式转换成手册页的命令行工具。codevis
codevis 是一个把文件夹里的源代码和其他 UTF-8 编码文件渲染成一张图片的工具,支持语法高亮的文件类型会自动着色。openssl@4
OpenSSL 是一套开源、商用级、功能完整的加密工具箱,主要服务于 TLS(早期称 SSL)、DTLS 和 QUIC 协议。xz
XZ Utils 是一个通用数据压缩库,同时附带命令行工具。它的原生格式是 .xz,也兼容旧的 .lzma 格式。gh
GitHub CLI(简称 gh)把 GitHub 上的 pull request、issue 等操作直接搬进了终端,让你在写代码、用 git 的同一个地方…所属分类:命令行工具