blocks|key|175152|text|要让Xcode显示您的类的文档，您必须使用Doxygen或HeaderDoc等工具为您的类创建一个文档集。创建文档集后，必须使用Xcode的文档首选项进行安装。苹果公司有一篇关于使用Doxygen的文章，但它涵盖了Xcode3，而不是4。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|175153|Using+Doxygen+to+Create+Xcode+Documentation+Sets|offset|length|175154|entityMap|0|LINK|mutability|MUTABLE|url|http://developer.apple.com/library/ios/#featuredarticles/DoxygenXcode/_index.html^0|0|0|1C|0|0^^$0|@$1|2|3|4|5|6|7|N|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|O|8|@]|9|@$D|P|E|Q|1|R]]|A|$]]|$1|F|3|-4|5|6|7|S|8|@]|9|@]|A|$]]]|G|$H|$5|I|J|K|A|$L|M]]]]

To get Xcode to show documentation for your classes, you must create a documentation set for your classes using a tool like Doxygen or HeaderDoc. After creating the documentation set, you must install it using Xcode's documentation preferences. Apple has an article on using Doxygen, but it covers Xcode 3, not 4.
<a href="http://developer.apple.com/library/ios/#featuredarticles/DoxygenXcode/_index.html" rel="noreferrer">Using Doxygen to Create Xcode Documentation Sets</a>

blocks|key|174750|text|Appledoc是目前生成xcode文档的最佳选择。Doxygen很棒，但它不能生成适用于您正在讨论的弹出窗口的文档集。Appledoc并不完美，但我们转向了它，并对结果感到非常满意。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|174751|​|174752|📷|atomic|174753|174754|entityMap|0|LINK|mutability|MUTABLE|url|https://github.com/tomaz/appledoc|1|IMAGE|IMMUTABLE|imageUrl|https://ask.qcloudimg.com/http-save/yehe-900000/4b47f31058b3db617ea19d4575777f56.jpeg|imageAlt^0|0|8|0|0|0|0|1|1|0|0^^$0|@$1|2|3|4|5|6|7|X|8|@]|9|@$A|Y|B|Z|1|10]]|C|$]]|$1|D|3|E|5|6|7|11|8|@]|9|@]|C|$]]|$1|F|3|G|5|H|7|12|8|@]|9|@$A|13|B|14|1|15]]|C|$]]|$1|I|3|E|5|6|7|16|8|@]|9|@]|C|$]]|$1|J|3|-4|5|6|7|17|8|@]|9|@]|C|$]]]|K|$L|$5|M|N|O|C|$P|Q]]|R|$5|S|N|T|C|$U|V|W|-4]]]]

<a href="https://github.com/tomaz/appledoc" rel="noreferrer">Appledoc</a> is the best option for generating xcode documentation at the moment. Doxygen is great, but it does not generate docsets that work very well for the popups you're talking about. Appledoc isn't perfect, but we moved over to it and have been really happy with the results.

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

blocks|key|3500419|text|从Xcode5.0开始，变量和方法的Xcode和HeaderDoc格式将自动解析并呈现在快速帮助弹出窗口中。更多关于它的信息，here，但这里有一些关键点：|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|3500420|/**
+*+Add+a+data+point+to+the+data+source.
+*+(Removes+the+oldest+data+point+if+the+data+source+contains+kMaxDataPoints+objects.)
+*
+*+@param+aDataPoint+An+instance+of+ABCDataPoint.
+*+@return+The+oldest+data+point,+if+any.
+*/
+-+(ABCDataPoint+*)addDataToDataSource:(ABCDataPoint+*)aDataPoint;|code-block|syntax|javascript|3500421|在Xcode中呈现为：|3500422|​|3500423|📷|atomic|3500424|3500425|至于属性，就像下面这样简单：|3500426|///+Base64-encoded+data.
@property+(nonatomic,+strong)+NSData+*data;|3500427|按住Option键并单击时，将显示此可爱的弹出窗口：|3500428|3500429|3500430|3500431|entityMap|0|LINK|mutability|MUTABLE|url|http://confusatory.org/post/63488534619/documentation-in-xcode-5|1|IMAGE|IMMUTABLE|imageUrl|https://ask.qcloudimg.com/http-save/yehe-900000/55f757a7d2eae6f2650e161005f7b1aa.png|imageAlt|2|https://ask.qcloudimg.com/http-save/yehe-900000/fbb2d32209883445ce5fdc96591837cc.png^0|1R|4|0|0|0|0|0|0|1|1|0|0|0|0|0|0|0|1|2|0|0^^$0|@$1|2|3|4|5|6|7|1F|8|@]|9|@$A|1G|B|1H|1|1I]]|C|$]]|$1|D|3|E|5|F|7|1J|8|@]|9|@]|C|$G|H]]|$1|I|3|J|5|6|7|1K|8|@]|9|@]|C|$]]|$1|K|3|L|5|6|7|1L|8|@]|9|@]|C|$]]|$1|M|3|N|5|O|7|1M|8|@]|9|@$A|1N|B|1O|1|1P]]|C|$]]|$1|P|3|L|5|6|7|1Q|8|@]|9|@]|C|$]]|$1|Q|3|R|5|6|7|1R|8|@]|9|@]|C|$]]|$1|S|3|T|5|F|7|1S|8|@]|9|@]|C|$G|H]]|$1|U|3|V|5|6|7|1T|8|@]|9|@]|C|$]]|$1|W|3|L|5|6|7|1U|8|@]|9|@]|C|$]]|$1|X|3|N|5|O|7|1V|8|@]|9|@$A|1W|B|1X|1|1Y]]|C|$]]|$1|Y|3|L|5|6|7|1Z|8|@]|9|@]|C|$]]|$1|Z|3|-4|5|6|7|20|8|@]|9|@]|C|$]]]|10|$11|$5|12|13|14|C|$15|16]]|17|$5|18|13|19|C|$1A|1B|1C|-4]]|1D|$5|18|13|19|C|$1A|1E|1C|-4]]]]

As of Xcode 5.0, Doxygen and HeaderDoc formatting for variables and methods is automatically parsed and rendered in the Quick Help popover. More information about it <a href="http://confusatory.org/post/63488534619/documentation-in-xcode-5" rel="noreferrer">here</a>, but here's some key bits:

<pre><code>/**
 * Add a data point to the data source.
 * (Removes the oldest data point if the data source contains kMaxDataPoints objects.)
 *
 * @param aDataPoint An instance of ABCDataPoint.
 * @return The oldest data point, if any.
 */
 - (ABCDataPoint *)addDataToDataSource:(ABCDataPoint *)aDataPoint;
</code></pre>

renders in Xcode as:

<img src="https://media.tumblr.com/bb59b3c3066ca01074c4c5458d8f57d6/tumblr_inline_mud7ufhJ4Q1qzs6su.png" alt="">

As for properties, it's as easy as:

<pre><code>/// Base64-encoded data.
@property (nonatomic, strong) NSData *data;
</code></pre>

When option-clicked, this lovely popover appears:

<img src="https://media.tumblr.com/22e6403fae4f63663ff433791006b937/tumblr_inline_mud80we32h1qzs6su.png" alt="">

blocks|key|3785775|text|嗯，看起来这些课程的问题还没有得到回答，所以我会把我的建议贴出来。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|3785776|就在MyClass.h文件中的@interface+MyClass+:+NSObject行之前，您可以像在示例中一样使用注释，但需要添加一些标记来显示文本。例如，下面的代码：|offset|length|style|CODE|3785777|/**
+*+@class+GenericCell
+*+@author+Average+Joe
+*+@date+25/11/13
+*
+*+@version+1.0
+*
+*+@discussion+This+class+is+used+for+the+generic+lists
+*/|code-block|syntax|javascript|3785778|将产生以下输出：the+output+of+the+code+above+http://imageshack.com/a/img18/2194/kdi0.png|3785779|entityMap|0|LINK|mutability|MUTABLE|url|http://imageshack.com/a/img18/2194/kdi0.png^0|0|F|T|0|0|8|20|0|0^^$0|@$1|2|3|4|5|6|7|W|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|X|8|@$D|Y|E|Z|F|G]]|9|@]|A|$]]|$1|H|3|I|5|J|7|10|8|@]|9|@]|A|$K|L]]|$1|M|3|N|5|6|7|11|8|@]|9|@$D|12|E|13|1|14]]|A|$]]|$1|O|3|-4|5|6|7|15|8|@]|9|@]|A|$]]]|P|$Q|$5|R|S|T|A|$U|V]]]]

Well, it seems that for the classes the question hasn't still been answered, so I'll post my suggestions.

Just before the <code>@interface MyClass : NSObject</code> line in the MyClass.h file you use the comment like you did in your example, but adding some tags to display the text. For example the code below:

<pre><code>/**
 * @class GenericCell
 * @author Average Joe
 * @date 25/11/13
 *
 * @version 1.0
 *
 * @discussion This class is used for the generic lists
 */
</code></pre>

will produce the following output:
<a href="http://imageshack.com/a/img18/2194/kdi0.png">the output of the code above http://imageshack.com/a/img18/2194/kdi0.png</a>

blocks|key|3500562|text|还可以在文档中添加一些代码片段，如下所示|type|unstyled|depth|inlineStyleRanges|entityRanges|data|3500563|​|3500564|📷|atomic|offset|length|3500565|3500566|通过添加以下代码|3500567|+*++@code
+*++-+(UIButton*)+createButtonWithRect:(CGRect)rect
+++++{
++++++++//+Write+your+code+here
+++++}
+*+@endcode|code-block|syntax|javascript|3500568|有关记录自定义类的方法的更多详细信息，请访问我的博客Function+Documentation+in+Xcode。|3500569|entityMap|0|IMAGE|mutability|IMMUTABLE|imageUrl|https://ask.qcloudimg.com/http-save/yehe-900000/6fb5eafd57b968246876994b95558a4f.png|imageAlt|1|LINK|MUTABLE|url|http://innofied.com/function-documentation-in-xcode/^0|0|0|0|1|0|0|0|0|0|Q|V|1|0^^$0|@$1|2|3|4|5|6|7|16|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|17|8|@]|9|@]|A|$]]|$1|D|3|E|5|F|7|18|8|@]|9|@$G|19|H|1A|1|1B]]|A|$]]|$1|I|3|C|5|6|7|1C|8|@]|9|@]|A|$]]|$1|J|3|K|5|6|7|1D|8|@]|9|@]|A|$]]|$1|L|3|M|5|N|7|1E|8|@]|9|@]|A|$O|P]]|$1|Q|3|R|5|6|7|1F|8|@]|9|@$G|1G|H|1H|1|1I]]|A|$]]|$1|S|3|-4|5|6|7|1J|8|@]|9|@]|A|$]]]|T|$U|$5|V|W|X|A|$Y|Z|10|-4]]|11|$5|12|W|13|A|$14|15]]]]

It is also possible to add some code snippet in documentation like the following 

<img src="https://i.stack.imgur.com/WrDZA.png" alt="Code snippet in Function Documentation in Xcode">

by adding the following code 

<pre><code> * @code
 * - (UIButton*) createButtonWithRect:(CGRect)rect
 {
 // Write your code here
 }
 * @endcode
</code></pre>

For more details of documenting methods of a custom class you can have a look on my blog <a href="http://innofied.com/function-documentation-in-xcode/" rel="noreferrer">Function Documentation in Xcode</a>.

How can I force Xcode to show my own documentation for custom classes, methods, etc.? I'm used to Java and Eclipse, which shows me documentation for my classes as shown here:

<img src="https://i.stack.imgur.com/czyo4.png" alt="Eclipse showing Javadocs documentation">

How can I achieve the same in Xcode? Are there special comments that Xcode can recognize and display?

<img src="https://i.stack.imgur.com/AvFpa.png" alt="Xcode showing generic documentation for NSObject">

Xcode: show documentation for my custom classes

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

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

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

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

文章

问答

视频

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

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

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

腾讯云数据库专区

腾讯云顾问专区

腾讯云原生专区

腾讯混元专区

腾讯云TCE专区

腾讯云Lighthouse专区

腾讯云HAI专区

腾讯云Edgeone专区

腾讯云存储专区

腾讯云智能专区

腾讯轻联专区 

腾讯云开发专区

TAPD专区

腾讯轻量云游戏服专区

腾讯云最具价值专家

腾讯云架构师技术同盟

腾讯云创作之星

腾讯云开发者先锋

腾讯云代码助手

云原生构建

TAPD 敏捷项目管理

Cloud Studio

SDK中心

API中心

命令行工具

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

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

如何强制Xcode显示我自己的自定义类、方法等文档？我习惯了Java和Eclipse，它向我展示了我的类的文档，如下所示：​​如何在Xcode中实现同样的功能？是否有Xcode可以识别和显示的特殊注释？​​

问Xcode:显示我的自定义类的文档
EN

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问Xcode:显示我的自定义类的文档EN