前言

碼農總是在搬磚，日復一日，年復一年，有的時候都會麻木。

代碼大家都會寫，但是把注釋寫好卻是一個技術活。

下面這段話，很好的說明了寫好注釋的感覺：

注釋代碼很像清潔你的廁所——你不想干，但如果你做了，這絕對會給你和你的客人帶來更愉悅的體驗。—— Ryan Campbell

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

Objective-C的代碼注釋

很久很久以前，在Xcode還可以安裝插件的時代，iOSer都通過VVDocument來編寫代碼注釋的。

代碼注釋的風格一般都是這樣的，代碼出自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的注釋是通過/** */這樣的形式進行編寫的。分隔符使用的是這種風格：

#pragma mark - 這個是一個分割符

image.png

需要注意的是這個-非常的重要，通過這個-，在查看代碼的時候，可以生成分隔線，讓代碼結構看的更為清晰。

Swift的代碼注釋

隨著Swift語言發布，在Swift中編寫注釋的風格就所有不同了：

extension NSObject {

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

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

    /// NSObject對象獲取類型
    public var runtimeType: NSObject.Type {
        return type(of: self)
    }

    /// 這是一個例子函數
    /// - Parameter arg:
    /// - Parameter argument: 傳入Int類型的參數
    /// - Returns: 返回Int類型的參數
    public func afunction(argument: Int) -> Int {
        return argument
    }
}

Swift的注釋是通過/// 這樣的形式進行編寫的。分隔符使用的是這種風格：

//MARK: - 綁定

image.png

Swift中的//MARK:這個-也是起到生成分隔線的作用。

Objective-C和Swift的注釋風格現在已經統一

如果你現在通過alt+cmd+/在OC和Swift中編寫注釋的時候，就會發現現在的注釋都變成了Swift的這個中風格了：

image.png

image.png

我個人建議是：以前代碼注釋就讓它去吧，現在就都是用這個統一風格。

快速修改注釋

一個函數寫好了，注釋也寫好，但是有的時候計劃沒有變化快，函數添加了新的參數，這個注釋難道要手動添加？別急，其實Xcode也為我們提供了快捷方式，我們繼續看例子，這個函數我在之前的基礎上添加了一個num參數，但是注釋還是之前的樣子：

image.png

cmd+鼠標左鍵點擊，我們可以看到左側出現了一個菜單，點擊Add Documentation

image.png

image.png

大家有興趣可以把菜單的選項都點擊試試，也許有意外的驚喜，比如Convert Function to Async，await/async。

參考文檔

VVDocumenter（https://github.com/onevcat/VVDocumenter-Xcode）