Xcode代码文档

Question

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

至少我有兴趣了解在代码中定义的接口/协议/方法之前是否存在编写注释的标准方法.我见过使用类似下面的指令,但我不明白它们是如何工作的:

#pragma mark -
#pragma mark Initialization

Answer 1

您可以将这两行合并为一个:#pragma mark - Initialization.单击方法列表(向上,向右),您将看到带有一行的粗体标题.它只是分组中方法分组的标记.

以上Derek发布的编码指南链接必读.

如果你想生产类似苹果的文档,你必须使用这个优秀的免费第三方工具:http://www.gentlebytes.com/appledoc/ Apple没有为你提供任何接近的东西.

Pragma是一种ISO C功能,用于将提示传递给编译器.

唯一的编译另外XCode中(据我所知)是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 mark,因为我的颜色主题是红色的pragma,它们比评论更突出.如果您想将pragma代码段绑定到热键,请使用

#pragma mark - <#Description#>

所以你可以跳转到描述文字.

关于pragma的更多信息:

• 什么是pragma？
• 6.56海湾合作委员会接受的语用学
• Clang 通过Pragma控制诊断
• 功能属性是首选编译指示,因为你不能生成宏编译指示和附注可能对其他的编译器有不同的含义.

Answer 2

添加到@ 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.*/
}