blocks|key|2224887|text|不要忘记阻塞代码的编译指示标记。它帮助XCode隔离下拉菜单中的方法。它还可以直观地分解源文件，使其更易于阅读。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|2224888|下面是我阻止代码段的方法：|2224889|///////////////////////////////////////////////////////////////////////////
#pragma+mark+-
#pragma+mark+View+Lifecycle
#pragma+mark+-
///////////////////////////////////////////////////////////////////////////

-+(void)+functionsHere|code-block|syntax|javascript|2224890|它最终在XCode中这样做：|2224891|​|2224892|📷|atomic|offset|length|2224893|2224894|entityMap|0|IMAGE|mutability|IMMUTABLE|imageUrl|https://ask.qcloudimg.com/http-save/yehe-900000/4506a9a960e3c7c054be70533916b1fd.png|imageAlt^0|0|0|0|0|0|0|1|0|0|0^^$0|@$1|2|3|4|5|6|7|11|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|12|8|@]|9|@]|A|$]]|$1|D|3|E|5|F|7|13|8|@]|9|@]|A|$G|H]]|$1|I|3|J|5|6|7|14|8|@]|9|@]|A|$]]|$1|K|3|L|5|6|7|15|8|@]|9|@]|A|$]]|$1|M|3|N|5|O|7|16|8|@]|9|@$P|17|Q|18|1|19]]|A|$]]|$1|R|3|L|5|6|7|1A|8|@]|9|@]|A|$]]|$1|S|3|-4|5|6|7|1B|8|@]|9|@]|A|$]]]|T|$U|$5|V|W|X|A|$Y|Z|10|-4]]]]

Don't forget about pragma marks for blocking your code. It helps XCode segregate the methods in the dropdown. It also visually breaks up your source file and makes it easier to read.

Here's how I block sections of code:

<pre><code>///////////////////////////////////////////////////////////////////////////
#pragma mark -
#pragma mark View Lifecycle
#pragma mark -
///////////////////////////////////////////////////////////////////////////

- (void) functionsHere
</code></pre>

It ends up doing this in XCode:

<img src="https://i.stack.imgur.com/M3yyw.png" alt="enter image description here">

blocks|key|5333313|text|还有一些可以使用的appledoc头文件，和Apple使用的是一样的。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|5333314|对于单独的方法，最好的指导是使用非常具描述性的名称，这在Objective-C中相当容易，方法名称中散布着参数。这通常消除了对单个参数注释的需要。|5333315|与任何语言一样，描述性方法名称和简短的单一用途方法优于随着代码更改而老化的冗长注释。|5333316|entityMap^0|0|0|0^^$0|@$1|2|3|4|5|6|7|H|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|I|8|@]|9|@]|A|$]]|$1|D|3|E|5|6|7|J|8|@]|9|@]|A|$]]|$1|F|3|-4|5|6|7|K|8|@]|9|@]|A|$]]]|G|$]]

There are appledoc header docs that can be used, the same ones Apple uses.

For individual methods the best guide is to use very descriptive names, this is rather easy in Objective-C with the parameters interspersed in the method name. This generally obviates the need for individual parameter comments.

As in any language descriptive method names and short single purpose methods beats lengthily comments that age poorly as code changes.

blocks|key|3221157|text|您提到的注释风格似乎就是文档生成器为您生成文档时所选择的样式。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|3221158|因此，对objective-c进行注释的等效风格将取决于您选择的文档生成器。据我所知，没有默认的。|3221159|如果你想要给出类似于苹果自己的开发者文档的结果，你可以使用Doxygen或appledoc。This+page详细介绍了注释格式。示例：GBComment.h|offset|length|3221160|entityMap|0|LINK|mutability|MUTABLE|url|http://www.doxygen.org/|1|https://github.com/tomaz/appledoc|2|http://www.gentlebytes.com/home/appledocapp/appledoc-documentation-comments/|3|https://github.com/tomaz/appledoc/blob/master/Model/GBComment.h^0|0|0|T|7|0|11|8|1|1A|9|2|1W|B|3|0^^$0|@$1|2|3|4|5|6|7|V|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|W|8|@]|9|@]|A|$]]|$1|D|3|E|5|6|7|X|8|@]|9|@$F|Y|G|Z|1|10]|$F|11|G|12|1|13]|$F|14|G|15|1|16]|$F|17|G|18|1|19]]|A|$]]|$1|H|3|-4|5|6|7|1A|8|@]|9|@]|A|$]]]|I|$J|$5|K|L|M|A|$N|O]]|P|$5|K|L|M|A|$N|Q]]|R|$5|K|L|M|A|$N|S]]|T|$5|K|L|M|A|$N|U]]]]

The style of commenting you mention seems to be the kind that a documentation generator picks up to generate documentation for you.

The equivalent style of commenting on objective-c would therefore be dependent on the documentation generator you choose. There is no default one as far as I know.

You can use something like <a href="http://www.doxygen.org/" rel="noreferrer">Doxygen</a>, or <a href="https://github.com/tomaz/appledoc" rel="noreferrer">appledoc</a> if you want something that gives results similar to Apple's own developer documentation. <a href="http://www.gentlebytes.com/home/appledocapp/appledoc-documentation-comments/" rel="noreferrer">This page</a> details the commenting format. Example: <a href="https://github.com/tomaz/appledoc/blob/master/Model/GBComment.h" rel="noreferrer">GBComment.h</a>

blocks|key|3221213|text|我是这样做的，|type|unstyled|depth|inlineStyleRanges|entityRanges|data|3221214|//-----------------------------------------------------------------------------------------------------//
#pragma+mark+-+Table+view+Datasource+-
//-----------------------------------------------------------------------------------------------------//|code-block|syntax|javascript|3221215|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|I|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|J|8|@]|9|@]|A|$E|F]]|$1|G|3|-4|5|6|7|K|8|@]|9|@]|A|$]]]|H|$]]

How I do is like this,

<pre><code>//-----------------------------------------------------------------------------------------------------//
#pragma mark - Table view Datasource -
//-----------------------------------------------------------------------------------------------------//
</code></pre>

blocks|key|319183|text|/**
*+++@brief++set+refresh+datetime
*
*+++@param++value+of+refresh+datetime
*
*+++@return
*
*/|type|code-block|depth|inlineStyleRanges|entityRanges|data|syntax|javascript|319184|这在快速帮助中显示|unstyled|319185|认为|319186|entityMap^0|0|0|0^^$0|@$1|2|3|4|5|6|7|K|8|@]|9|@]|A|$B|C]]|$1|D|3|E|5|F|7|L|8|@]|9|@]|A|$]]|$1|G|3|H|5|F|7|M|8|@]|9|@]|A|$]]|$1|I|3|-4|5|F|7|N|8|@]|9|@]|A|$]]]|J|$]]

<pre><code>/**
* @brief set refresh datetime
*
* @param value of refresh datetime
*
* @return
*
*/
</code></pre>

this is displayed on quick help

thinks

blocks|key|3221164|text|您将使用|type|unstyled|depth|inlineStyleRanges|entityRanges|data|3221165|//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;*/|code-block|syntax|javascript|3221166|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|I|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|J|8|@]|9|@]|A|$E|F]]|$1|G|3|-4|5|6|7|K|8|@]|9|@]|A|$]]]|H|$]]

You would use 

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

What is the proper way to comment methods for Objective-C? For example, in .Net I would add a xml comment like:
<pre><code>/// &lt;summary&gt;
/// Summary of method
/// &lt;/summary&gt;
/// &lt;param name=&quot;FileName&quot;&gt;The document's original filename.&lt;/param&gt; 
/// &lt;returns&gt;Decoded filename&lt;/returns&gt; 
</code></pre>
Is there an equivalent for Objective-C?

Objective-C Method Comments

翻译质量差，导致语言生硬或混乱。

没有提供实际的解决方法或示例。

解答不清晰，无法理解或解决问题。

页面排版不美观，阅读体验差。

文章

问答

视频

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

腾讯iOA零信任安全管理系统专区

腾讯云架构师技术同盟交流圈

腾讯云数据库专区

腾讯云顾问专区

腾讯云原生专区

腾讯混元专区

腾讯云TCE专区

腾讯云Lighthouse专区

腾讯云HAI专区

腾讯云Edgeone专区

腾讯云存储专区

腾讯云智能专区

腾讯轻联专区 

腾讯云开发专区

TAPD专区

腾讯轻量云游戏服专区

腾讯云最具价值专家

腾讯云架构师技术同盟

腾讯云创作之星

腾讯云开发者先锋

腾讯云代码助手

云原生构建

TAPD 敏捷项目管理

Cloud Studio

SDK中心

API中心

命令行工具

涵盖代码开发、场景应用、自动测试全流程，助你从零构建专属AI助手

一站式MCP教程库，解锁AI应用新玩法

为Objective-C注释方法的正确方式是什么？例如，在.Net中，我会添加如下的xml注释：/// <summary>/// Summary of method/// </summary>/// <param name="FileName">The document's original filename.</param> /// <returns>Decoded filename</ret

问Objective-C方法注释
EN

回答 6

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问Objective-C方法注释EN

回答 6

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问Objective-C方法注释
EN