Objective C方法评论

Question

为Objective C评论方法的正确方法是什么？例如,在.Net中我会添加一个xml注释,如:

/// <summary>
/// Summary of method
/// </summary>
/// <param name="FileName">The document's original filename.</param>  
/// <returns>Decoded filename</returns>  

Objective C是否有等价物？

Answer 1

不要忘记用于阻止代码的pragma标记.它有助于XCode在下拉列表中分离方法.它还可以直观地分解您的源文件并使其更易于阅读.

以下是我阻止代码部分的方法:

///////////////////////////////////////////////////////////////////////////
#pragma mark -
#pragma mark View Lifecycle
#pragma mark -
///////////////////////////////////////////////////////////////////////////

- (void) functionsHere

它最终在XCode中执行此操作:

Answer 2

有appledoc标题文档可以使用,与Apple使用的相同.

对于单个方法,最好的指南是使用非常具有描述性的名称,这在Objective-C中相当容易,其中的参数散布在方法名称中.这通常不需要单独的参数注释.

正如在任何语言中一样,描述性方法名称和简短的单一目的方法胜过长时间的评论,这些评论随着代码的变化而变差.

Answer 3

您提到的评论风格似乎是文档生成器选择为您生成文档的类型.

因此,对objective-c进行注释的等效样式将取决于您选择的文档生成器.据我所知,没有默认的.

你可以使用像Doxygen或appledoc这样的东西,如果你想要的东西给出与Apple自己的开发者文档相似的结果.此页面详细说明了评论格式.示例:GBComment.h