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进行注释的等效样式将取决于您选择的文档生成器。据我所知，没有默认的。

如果您想要的结果类似于Apple自己的开发者文档，您可以使用Doxygen或appledoc之类的内容。 This page详细说明了评论格式。示例：GBComment.h

Answer 4

我是怎么做的，

//-----------------------------------------------------------------------------------------------------//
#pragma mark - Table view Datasource -
//-----------------------------------------------------------------------------------------------------//

Answer 5

/**
*   @brief  set refresh datetime
*
*   @param  value of refresh datetime
*
*   @return
*
*/

这会显示在快速帮助

上

认为

Answer 6

你会用

//for a single line comment
/*Use this for the start of a block comment
*/Use this for the end of a comment
   /*text text text;
   code code;
   code code code;//comment
   code;//comment
   code;*/