挑战:创建高质量的文稿

探索 Xcode 的新文稿功能,了解如何将文稿添加至您自己的框架或软件包,或者添加至您感兴趣的开源项目。在这项挑战中,我们将请您为自己的框架或软件包 (或您感兴趣的开源项目) 创建文稿。请使用 Xcode 13 在您的 Swift 框架中从标题注释创建文稿,并添加文稿目录来组织您的
内容。

开始挑战

在 Xcode 中打开您的项目,然后使用 Swift DocC markdown 语法在您的源代码中添加文稿注释。DocC 将使用您在源代码中编写的注释,作为其生成的文稿页的内容。至少,DocC 也会将基本的文稿注释添加至框架的公共符号,用作单句摘要或总结。例如:

完成文稿之后,您可以选择“产品” > “创建文稿”,为“快速帮助”和“开发者文稿”窗口生成源文稿。

在编写或构建文稿方面需要帮助?请加入开发者工具数字大厅。您可于星期四下午 1 点至 5 点 (太平洋夏令时),在 #devtools-study-hall 频道中访问开发者工具学堂,以分享您的进度、询问项目相关问题以及与其他人进行协作。您也可以使用 "WWDC21-Challenges" 标记在开发者论坛上分享您的进度,或者使用井字号标记 #WWDC21Challenges 在社交媒体上进行分享。

Visit the Apple Developer Forums

资源

Documenting a Swift Framework or Package

Read the WWDC21 Challenges Terms and Conditions