Xcode 12.4下Swift API文档注释编写的编辑器支持问题咨询

1 自动生成注释模板 #

Xcode原生已支持该功能，将光标放置在需要添加注释的函数、类、属性等符号上方，按下快捷键Option + Command + /即可自动生成包含参数列表、返回值、摘要占位符的标准注释模板，按Tab可快速在不同占位符之间切换填写。

2 回车自动补全///前缀 #

该功能可通过Xcode偏好设置开启：打开Xcode > Preferences > Text Editing > Editing，勾选Automatically continue comments after newline选项，此后在///开头的注释行末尾按下回车，下一行会自动补全///前缀。

3 按配置列数自动换行 #

首先可在Xcode > Preferences > Text Editing > Display中开启Page guide at column选项，设置你需要的换行列数（通常为80或120），编辑界面会显示对应列数的辅助指示线，方便判断换行位置。
如果需要自动对已有注释内容按配置列数折行，选中目标注释内容后，执行Editor > Structure > Re-Indent命令即可自动完成折行排版。

4 自动正确缩进换行内容 #

原生Xcode已支持参数列表、描述段落的自动缩进：在- Parameter、- Returns等列表项末尾换行时，会自动将下一行内容缩进对齐到列表项内容的起始位置；如果出现缩进错误，选中对应内容后按下Ctrl + I执行重新排版即可修正缩进问题。

如果上述原生功能无法满足个性化的注释规范需求，可使用Xcode扩展类工具自定义注释规则，覆盖上述所有场景的需求。

内容的提问来源于stack exchange，提问作者Feuermurmel