☰ 菜单
首页›命令行工具›sourcedocs
命令行 开源 4 次安装/月

sourcedocs for Mac 版

sourcedocs

从内联源代码文档生成 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 文档、并让文档随代码内联浏览的开发者。

如何安装 sourcedocs

  1. 打开 终端(按 ⌘ + 空格,输入“终端”)。
  2. 如果还没安装 Homebrew,先运行下面这条安装命令。
  3. 运行下面这条命令:

最近 10 个版本记录

最近一次更新为 2022-04-02,当前版本 2.0.1,共记录最近 10 个版本。

版本发布日期类型大小macOSWindowsLinux
2.0.12022-04-02稳定版————
2.0.02021-11-29稳定版1.3 MB下载——
1.2.12020-07-31稳定版3.4 MB下载——
1.2.02020-06-04稳定版3.4 MB下载——
1.1.02020-05-27稳定版3.4 MB下载——
1.0.02020-05-11稳定版2.9 MB下载——
0.6.12019-11-03稳定版904 KB下载——
0.6.02019-11-01稳定版904 KB下载——
0.5.12018-09-26稳定版3.8 MB下载——
0.5.02017-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 天安装
sourcedocs2.0.1MIT命令行4
jsrepo3.8.2MIT命令行7
pod2man6.1.1Artistic-1.0-Perl OR GPL-1.0-or-later命令行7
codevisv0.8.4MIT命令行7

命令行工具中的类似应用

发表评论

电子邮件地址不会被公开。必填项已用 * 标注。