写代码也有一段时间了，代码中注释也是写了不老少，但在和同事一起开发的时候才发现了问题，大家注释的样子各成一体，没有能写出苹果官方注释的样子。大概就是注释的语法上出了问题，于是自己就主动学习了下 Swift代码的注释语法格式，记录下自己学到的东西。

当我们用 ⌥ + 鼠标左键，点击代码时，可以查看属性或者方法的文档页面，更直观的查看代码的文档说明。

多数时候，我们都在使用这个方法注释类，结构体、枚举，属性，方法

在代码中，如果连续很多个单行注释，可换成多行注释，避免写很多单行注释，造成多余代码。

可以在多行文档注释中加入一些MD语法，就可以达到文档页面的特殊样式。

在 Xcode中写 Swift代码程序注释，本身就有其支持的 MarKDown 语法。还有一些特殊的标记，可以在右边mini 代码预览中展示，也可以在最上边的文件路径层次里查看。

用于标记代码结构，而且在Xcode 中右边mini map 中可以看到

这个用来提示下一步编写代码的目的或者实现逻辑。

提示这个地方的代码需要修复，存在某种需要修复问题。

在开发中，我们可以用 快捷键⌥ + ⌘ + / ，来为代码生成文档注释///。

其中 - Parameters:写法，还有- Throws:，- Returns:写法，都是特殊的关键字符格式，会在文档注释的页面特别显示。

可以在下图中的看到生成的文档样式，那些关键字起到一些标题的作用，让文档更清晰明了。而且是 Xcode 根据注释语法，自动生成的文档说明。

另外，在多行文档注释中，还可以使用 MarkDown语法进行书写。还有一些其他的关键字，也可在注释文档中使用。可参照下边代码，或者自行学习MarkDown语法。