Xcode代码文档

有关于如何记录用XCode编写的代码的指导方针/标准吗？我的意思是，如果你想让别人容易理解，有没有办法记录代码？ XCode是否提供了一种可用于自动生成文档的工具，如代码+注释中的API参考文档？Xcode代码文档

至少我有兴趣了解在你的代码中定义的接口/协议/方法之前是否有写评论的标准方法。我一直在使用的指令类似以下见过，但我不明白它们是如何工作：

#pragma mark - 
#pragma mark Initialization

来源

2011-09-22 Gianni Costanzi

我建议你阅读这篇文章苹果准备：
[*编码可可*指引]（https://developer.apple.com/library/mac/documentation/Cocoa/Conceptual/CodingGuidelines/CodingGuidelines。 html） –

您可以在一个合并这两条线：#pragma mark - Initialization。点击方法列表（向上，右侧），你会看到一个带粗线的粗体标题。这只是一个标记，可以分段分组。

上面Derek发布的编码指南链接是必须阅读的。

如果您想制作类似苹果的文档，您必须使用这款优秀且免费的第三方工具：http://www.gentlebytes.com/appledoc/ Apple不会为您提供任何与之相近的内容。

Pragma是一种ISO C功能，可将提示传递给编译器。

XCode（AFAIK）中唯一编译指示是mark和-和/或文本。这会在方法查找器中创建一行和/或粗体文本。

// 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 mark - <#Description#>

所以你可以跳转到描述文本标签。

更多关于编译指示：

What is a pragma?
6.56 Pragmas Accepted by GCC
锵的Controlling Diagnostics via Pragmas
Function attributes是首选编译指示，因为你不能生成宏编译指示和附注可能会在具有不同的含义另一个编译器

来源

2011-09-22 22:21:22 Jano

我在哪里可以找到关于这些编译指示标记指令的更多信息？ –

有关如何使用这些_pragma mark_指令的任何提示？有没有解释他们的文档？ –

..你去吧！ – Jano

添加@ jano的答案，使用下面的格式来描述您的方法的功能。

/*! 
@function  getEmployeeDetails 
@abstract  getEmployeeDetails 
@discussion  This function will fetch employee details based on employee id 
@param   strEmpId 
employee unique id 
@result   an Array of Employee 
*/ 

-(NSArray*)getEmployeeDetails:(NSString *)strEmpId{ 
    /*Do somethings.*/ 
}

来源

2014-01-29 06:27:25 Boobalan

Xcode代码文档

回答

相关问题