如何在Objective-C/Swift中记录自定义类的描述？

我知道您可以使用//（三重斜杠）注释变量，甚至可以使用

/**

对函数等进行doxygen风格的注释，但是是否有方法记录自定义类本身？所以，如果有人选择在Xcode中单击它，就会有一个描述？

你可以用不同的方式记录，比如

/*!
 * @discussion <#description#>
 * @param <#param description#>
 * @return <#return description#>
 */

/*！
*@讨论
*@param
*@返回
*/

请参阅下面链接中有关

@讨论

关键字以及如何使用代码片段快速使用这些注释的详细说明

---

我也遇到了同样的问题，找到了解决办法

要使用Doxygen对自定义类进行注释时，可以使用@file标记（或\file标记）。 （在Doxygen文档站点中，这是一种推荐的方法，但经常被忽略。）

用标签写下你想要的评论

就这样

例如：

/*!
@file CustomViewController.h
*/
#import <UIKit/UIKit.h>

/*!
 @brief The CustomViewController Header file

 @discussion CustomVC

 @superclass SuperClass: UIViewController
 @classdesign    No special design is applied here.
 @coclass    AppDelegate
 @helps It helps no other classes.
 @helper    No helper exists for this class.
 @author dakeshi
 @version 1.0
*/

@interface CustomViewController : UIViewController

/*！
@文件CustomViewController.h
*/
#进口
/*!
@简要介绍CustomViewController头文件
@论客户价值
@超类超类：UIViewController
@classdesign此处不应用特殊设计。
@coclass AppDelegate
@它对其他课程没有帮助。
@帮助程序此类不存在任何帮助程序。
@作者达克什
@版本1.0
*/
@界面CustomViewController:UIViewController

**我用Xcode 6.2测试了这段代码

您可以识别@file标记是分开的。如果我在第二个注释块中移动了@file标记，Doxygen无法生成我想要的文档。它只能完美地工作@file标签是单独描述的。（我还找不到原因。）

---

您可以在第二个注释块中使用@class、@protocol标记，但需要非常小心地使用它。有些标记必须与换行符一起使用（例如@discussion、@class），因为苹果保留了和某些标记同名的关键字）。如果在上面的示例中使用不带换行符的@class标记，您就可以看到关于UIViewController的普通apple文档

只需将这些

//

注释放在类声明之前（即Swift中的

类

语句之前，或Objective-C中的

@接口

之前）。请注意，两种语言中用于记录函数的语法不同。在Objective-C中，您使用的是doxygen样式，其中为Swift。Swift注释写在重组文本的子集中。您可以重复使用

HeaderDoc标记

来记录您的类。一些标记仅用于函数。但是

@discussion

@brief

也适用于课堂。或者您可以使用

/***在
@interface
之前，您的文档注释将转到此处*/

，以告知calss说明