我已经看到Apple的HeaderDoc User Guide已被标记为“已退休文件”,并附有此说明:
重要提示:本文档可能并不代表当前开发的最佳做法。下载和其他资源的链接可能不再有效。
本文件最后更新于5月。那么......现在在Xcode 8中记录代码的最佳实践是哪种?我没有找到关于此的进一步信息。
答案 0 :(得分:3)
Apple在xCode 8中添加了新功能,可以在代码中轻松添加文档。为此,只需将光标移动到任何符号,然后选择编辑器&gt; <结构>添加文档(Command-Option- /)。 Xcode会扫描您选择的符号,并添加一个doc-comment大纲,包括命名参数和返回类型(如果存在)。
更多信息: http://ericasadun.com/2016/09/16/xcode-8-document-coding-enhancements/