有没有关于如何记录用XCode编写的代码的准则/标准？我的意思是,有没有办法记录代码,如果你想让别人容易理解？ XCode是否提供了一个可以用于自动生成文档的工具,如代码注释中的API参考文档？
至少我有兴趣了解在代码中定义的接口/协议/方法之前是否有标准的方式写入注释.我已经看到使用如下的指令,但是我不明白它们是如何工作的：
至少我有兴趣了解在代码中定义的接口/协议/方法之前是否有标准的方式写入注释.我已经看到使用如下的指令,但是我不明白它们是如何工作的：
#pragma mark - #pragma mark Initialization
谢谢
詹尼
解决方法
您可以将这两行合并在一起：#pragma mark – 初始化.点击方法列表(向上,向右),您将看到一条带有一行的粗体标题.它只是一个标记来分组方法.
Derek上面发布的编码指南链接是必须阅读的.
如果你想生产类似苹果的文档,你必须使用这个优秀和免费的第三方工具：http://www.gentlebytes.com/appledoc/苹果不提供任何接近的东西.
XCode(AFAIK)中唯一的编写加法是用 – 和/或文本标记的.这将在方法查找器中创建一行和/或粗体文本.
// Mark a section in your code with a line and a bold text. // You can use the line or the text alone. #pragma mark - random text
如果您正在使用GCC编译的语言编辑文件,您仍然可以在注释上使用标记(这也适用于GCC语言)：
// MARK: - random text /* MARK: more random text */
但是我使用#pragma标记,因为我的颜色主题具有红色的编译指示,它们比注释更好.如果你想要一个绑定到热键的pragma代码片段,请使用
#pragma mark - <#Description#>
所以你可以跳转到描述文本.
更多关于pragmas：
> What is a pragma?
> 6.56 Pragmas Accepted by GCC
> Clang的Controlling Diagnostics via Pragmas
> Function attributes优先于编译指示,因为您无法从宏生成编译指示,而另一个编译器的pragma可能具有不同的含义.
