如何在HeaderDoc中添加多行注释

时间:2014-07-27 08:16:15

标签: ios objective-c documentation headerdoc

这是我的代码

/**
 *    In touchesBegan: it is considered if it was succesfull click. Automatically changes on/off images
 */
@interface WOC_OnOffImageButton : SKSpriteNode

当我在WOC_OnOffImageButton内的弹出框中点按Description时,我会在一行中获得In touchesBegan: it is considered if it was succesfull click. Automatically changes on/off images

我希望... click. Automatically...之间有新的界限,因为它更容易阅读。

问题
它是否可行,如果可行,该如何做?

1 个答案:

答案 0 :(得分:3)

enter image description here

是的,AppleDoc支持多行注释。以下是您使用它们的方式:

 /**
 *    In touchesBegan: it is considered if it was succesfull click.
 *
 *    Automatically changes on/off images
 */

关键是在新线上加上星号。您可能需要保存(Cmd+S)和/或清理(Cmd+Shift+K)项目以在弹出窗口中查看结果。