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

Question

我知道您可以使用///（三斜杠）来注释变量，甚至可以使用/**来对函数等进行doxygen样式的注释，但是有没有办法记录自定义类本身？ 因此，如果有人选择在Xcode中单击它，将会有描述吗？

Answer 1

我遇到了同样的问题，找到了解决方案。

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

2. 用标签写评论

而已。

例如 ：

/*!
@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

**我使用Xcode 6.2测试了此代码

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

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

Answer 2

您可以使用不同的方式进行记录，例如

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

在下面的链接中查看@discussion关键字的详细说明以及如何通过代码片段快速使用这些注释

http://www.raywenderlich.com/66395/documenting-in-xcode-with-headerdoc-tutorial