5分钟上手Swift编程语言中文版:DocC本地预览与快速开始教程
【免费下载链接】the-swift-programming-language-in-chinese中文版 Apple 官方《Swift 编程语言》项目地址: https://gitcode.com/gh_mirrors/th/the-swift-programming-language-in-chinese
本仓库是 Apple 官方《The Swift Programming Language》(Swift 编程语言)的简体中文翻译版,由 SwiftGG 团队维护,基于 Swift-DocC 构建。只要安装好 Xcode 或 Swift 工具链,在仓库根目录运行一条docc preview命令,就能在浏览器中打开完整的 Swift 入门文档,本地预览、离线阅读一站搞定。
这个仓库有什么?
| 板块 | 内容 | 适合人群 |
|---|---|---|
| 🚀 GuidedTour 入门导览 | AboutSwift、兼容性、官方引导教程 | 零基础新手 |
| 📖 LanguageGuide 语言指南 | 基本语法、函数、闭包、泛型等 28 个主题 | 系统学习者 |
| 🧩 ReferenceManual 语言参考 | 词法结构、表达式、声明等细节参考 | 进阶开发者 |
| 📜 RevisionHistory 修订历史 | 各版本更新记录 | 老用户回顾 |
整个文档的"目录总入口"是 TSPL.docc/The-Swift-Programming-Language.md,它用 DocC 的Topics语法把所有章节组织成树状导航,你在浏览器里看到的侧边栏目录就是由它生成的。构建配置则定义在 TSPL.docc/Info.plist 中(文档标识为org.swift.tspl)。
Swift 快速开始:三步完成 DocC 本地预览
第 1 步:获取源码
在终端中执行以下命令克隆仓库:
git clone https://gitcode.com/gh_mirrors/th/the-swift-programming-language-in-chinese第 2 步:安装 Swift DocC 工具(最快方法)
两种任选其一:
- macOS 用户:安装 [Xcode] 后直接获得
docc,建议通过xcrun调用; - Linux / Windows 用户:从 Swift.org 下载 toolchain,
docc位于安装路径下的usr/bin/目录,注意把它加入PATH环境变量。
💡 提示:安装 Xcode 后请使用
xcrun docc preview的写法,避免 PATH 配置问题。详细说明见 README.md 的"构建"章节。
第 3 步:运行预览,浏览器打开链接
进入仓库根目录,执行:
docc preview TSPL.docc命令运行后会在终端打印一个本地链接(类似http://127.0.0.1:xxxxx/),在浏览器中打开即可看到完整的 Swift 官方文档中文版页面。想体验正式发布效果的话,CI 使用的构建参数可以参考 .github/workflows/publish.yml。
Swift 入门路线图:建议的阅读顺序
建议新手按以下路线学习,配合本地预览边读边练:
- 先读入门导览—— 从 GuidedTour 引导教程 建立 Swift 的第一印象;
- 再啃语言指南—— 从 TheBasics 基础 开始,依次学习运算符、字符串、集合类型、控制流等核心语法;
- 深入进阶主题—— 闭包、泛型、协议、自动引用计数(ARC)与内存安全是区分新手和熟手的关键章节;
- 查阅语言参考—— 遇到语法细节时,ReferenceManual 是最权威的中文速查手册。
一图胜千言:文档中的经典插图
这本书的一大特色是丰富的可视化插图,本地预览时都能直接看到。以下几张是读者公认最直观的代表作:
| 插图 | 出自章节 | 讲解内容 |
|---|---|---|
| 栈的 push/pop 示意 | Generics.md | 用五步动画式图解理解栈结构 |
| 购物清单内存变化 | MemorySafety.md | 值类型复制前后内存状态对比 |
| 宏展开全流程 | Macros.md | 源码如何被宏实现改写成新代码 |
常见问题 FAQ
❓ 运行docc preview提示找不到命令?确认docc所在目录已加入PATH;macOS 上改用xcrun docc preview TSPL.docc即可绕过。
❓ 该预览swift-6.docc还是TSPL.docc?以仓库中实际存在的.docc目录为准。当前结构下的 DocC 目录为TSPL.docc(部分翻译分支的 README 中写作swift-6.docc),执行前可以先用ls *.docc确认。
❓ 可以离线使用吗?可以。预览服务运行在本机,文档与插图均来自本地仓库,无需联网即可完整阅读。
写在最后
从克隆仓库到浏览器中翻开中文版的《Swift 编程语言》,只需要 3 条命令、不到 5 分钟。现在就可以从 TheBasics 基础 开始你的 Swift 学习之旅,祝旅途愉快!🎉
【免费下载链接】the-swift-programming-language-in-chinese中文版 Apple 官方《Swift 编程语言》项目地址: https://gitcode.com/gh_mirrors/th/the-swift-programming-language-in-chinese
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考