Xcode中代碼注釋編寫的一些小技巧

更新時(shí)間：2021年10月28日 09:42:25 作者：season_zhu

如何在 Xcode 中編寫規(guī)范注釋,規(guī)范注釋可以在Xcode的快速幫助檢查器(quickheliector)中顯示,這篇文章主要給大家介紹了關(guān)于Xcode中代碼注釋編寫的一些小技巧,需要的朋友可以參考下

前言

碼農(nóng)總是在搬磚，日復(fù)一日，年復(fù)一年，有的時(shí)候都會(huì)麻木。

代碼大家都會(huì)寫，但是把注釋寫好卻是一個(gè)技術(shù)活。

下面這段話，很好的說(shuō)明了寫好注釋的感覺(jué)：

注釋代碼很像清潔你的廁所——你不想干，但如果你做了，這絕對(duì)會(huì)給你和你的客人帶來(lái)更愉悅的體驗(yàn)?！?Ryan Campbell

今天給大家聊的就是在Xcode中，代碼注釋編寫小技巧。

Objective-C的代碼注釋

很久很久以前，在Xcode還可以安裝插件的時(shí)代，iOSer都通過(guò)VVDocument來(lái)編寫代碼注釋的。

代碼注釋的風(fēng)格一般都是這樣的，代碼出自IQKeyboardManager/IQBarButtonItem

#import <UIKit/UIBarButtonItem.h>

@class NSInvocation;

/**
 IQBarButtonItem used for IQToolbar.
 */

@interface IQBarButtonItem : UIBarButtonItem

/**
 Boolean to know if it's a system item or custom item
 */
@property (nonatomic, readonly) BOOL isSystemItem;

/**
 Additional target & action to do get callback action. Note that setting custom target & selector doesn't affect native functionality, this is just an additional target to get a callback.

 @param target Target object.
 @param action Target Selector.
 */
-(void)setTarget:(nullable id)target action:(nullable SEL)action;

/**
 Customized Invocation to be called when button is pressed. invocation is internally created using setTarget:action: method.
 */
@property (nullable, strong, nonatomic) NSInvocation *invocation;

@end

OC的注釋是通過(guò)/** */這樣的形式進(jìn)行編寫的。

分隔符使用的是這種風(fēng)格：

#pragma mark - 這個(gè)是一個(gè)分割符

需要注意的是這個(gè)-非常的重要，通過(guò)這個(gè)-，在查看代碼的時(shí)候，可以生成分隔線，讓代碼結(jié)構(gòu)看的更為清晰。

Swift的代碼注釋

隨著Swift語(yǔ)言發(fā)布，在Swift中編寫注釋的風(fēng)格就所有不同了：

extension NSObject {

    /// 對(duì)象獲取類的字符串名稱
    public var className: String {
        return runtimeType.className
    }

    /// 類獲取類的字符串名稱
    public static var className: String {
        return String(describing: self)
    }

    /// NSObject對(duì)象獲取類型
    public var runtimeType: NSObject.Type {
        return type(of: self)
    }
    
    /// 這是一個(gè)例子函數(shù)
    /// - Parameter arg:
    /// - Parameter argument: 傳入Int類型的參數(shù)
    /// - Returns: 返回Int類型的參數(shù)
    public func afunction(argument: Int) -> Int {
        return argument
    }
}

Swift的注釋是通過(guò)/// 這樣的形式進(jìn)行編寫的。

分隔符使用的是這種風(fēng)格：