Iphone 客观C方法评论

什么是评价Objective-C方法的正确方式？例如，在.Net中，我会添加一个xml注释，如：

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

//
///方法概述
/// 
///文档的原始文件名。
///解码文件名

---

Objective-C是否有等效文档？

可以使用appledoc头文档，与Apple使用的相同

对于单个方法，最好的指导是使用非常描述性的名称，这在Objective-C中非常容易，参数散布在方法名称中。这通常不需要单独的参数注释

---

正如在任何语言中一样，描述性方法名称和简短的单一用途方法都比不上随着代码更改而过时的冗长注释。

您提到的注释风格似乎是文档生成器为您生成文档时选择的那种

因此，对objective-c进行评论的等效风格取决于您选择的文档生成器。据我所知，没有默认值

你可以使用类似的东西，或者如果你想得到类似于苹果自己的开发者文档的结果。详细说明评论格式。示例：

您将使用

//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;*/

---

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

下面是我如何阻止代码段的：

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

- (void) functionsHere

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

我是这样做的

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

这将显示在快速帮助中

---

想

谢谢你的快速回复。我知道如何在代码中注释，但我想知道是否有一种特定的格式用于注释上述方法，以解释该方法的功能。我希望能够单击方法实现并让它显示该方法的功能。您是否可以在快速帮助中显示注释，例如填写摘要和返回值？appledoc-Objective C API documentation generator Doxygen样式用于多行注释等是

/***/。不需要为此编写单独的行，只有一行就可以了。请参阅我的回答是的，但我有意添加额外的行，因此分解源文件是一个很大的障碍。除了获得下拉列表之外，我还希望能够滚动文件并看到它被可视化分割。这并不能回答这个问题。要评论或要求作者澄清，请在他们的帖子下方留下评论——你可以随时在自己的帖子上发表评论，一旦你有足够的评论，你就可以发表评论了。我是中国人。英语很差，所以我不知道你的意思是批评或要求作者澄清
/**
*   @brief  set refresh datetime
*
*   @param  value of refresh datetime
*
*   @return
*
*/