Xcode中代码注释编写的一些小技巧

 更新时间:2021年10月28日 09:42:25   作者:season_zhu  
如何在 Xcode 中编写规范注释,规范注释可以在Xcode的快速帮助检查器(quickheliector)中显示,这篇文章主要给大家介绍了关于Xcode中代码注释编写的一些小技巧,需要的朋友可以参考下

前言

码农总是在搬砖,日复一日,年复一年,有的时候都会麻木。

代码大家都会写,但是把注释写好却是一个技术活。

下面这段话,很好的说明了写好注释的感觉:

注释代码很像清洁你的厕所——你不想干,但如果你做了,这绝对会给你和你的客人带来更愉悦的体验。—— 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 - 这个是一个分割符

需要注意的是这个-非常的重要,通过这个-,在查看代码的时候,可以生成分隔线,让代码结构看的更为清晰。

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: - 绑定

Swift中的//MARK:这个-也是起到生成分隔线的作用。

Objective-C和Swift的注释风格现在已经统一

如果你现在通过alt+cmd+/在OC和Swift中编写注释的时候,就会发现现在的注释都变成了Swift的这个中风格了:

我个人建议是:以前代码注释就让它去吧,现在就都是用这个统一风格。

快速修改注释

一个函数写好了,注释也写好,但是有的时候计划没有变化快,函数添加了新的参数,这个注释难道要手动添加?

别急,其实Xcode也为我们提供了快捷方式,我们继续看例子,这个函数我在之前的基础上添加了一个num参数,但是注释还是之前的样子:

cmd+鼠标左键点击,我们可以看到左侧出现了一个菜单,点击Add Documentation

我们需要添加的参数它就来了,这样就可以直接添加注释了。

大家有兴趣可以把菜单的选项都点击试试,也许有意外的惊喜,比如Convert Function to Async,await/async。

参考文档

VVDocumenter

总结

从VVDocument到注释的统一,Xcode一直都在做改进,虽然依旧不尽人意。

但是写好注释,也算是码农的一个基本素养吧,大家加油修炼。

到此这篇关于Xcode中代码注释编写小技巧的文章就介绍到这了,更多相关Xcode代码注释编写内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • iOS中的多线程如何按设定顺序去执行任务详解

    iOS中的多线程如何按设定顺序去执行任务详解

    多线程相信大家或多或少都有所了解吧,下面这篇文章主要给大家介绍了关于iOS中多线程如何按设定顺序去执行任务的相关资料,文中通过示例代码介绍的非常详细,对各位iOS开发者们的学习或者工作具有一定的参考学习价值,需要的朋友们下面来一起看看吧。
    2017-12-12
  • Objective-C中NSArray的基本用法示例

    Objective-C中NSArray的基本用法示例

    这篇文章主要介绍了Objective-C中NSArray的基本用法示例,包括基本的排序等方法的介绍,需要的朋友可以参考下
    2015-09-09
  • IOS开发实现手机震动的提示实例代码

    IOS开发实现手机震动的提示实例代码

    这篇文章主要介绍了IOS开发实现手机震动的提示实例代码的相关资料,需要的朋友可以参考下
    2017-04-04
  • iOS实现微信朋友圈与摇一摇功能

    iOS实现微信朋友圈与摇一摇功能

    这篇文章主要为大家详细介绍了iOS实现微信朋友圈与摇一摇功能,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-08-08
  • iOS实现垂直滑动条效果

    iOS实现垂直滑动条效果

    这篇文章主要为大家详细介绍了iOS实现垂直滑动条效果,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-03-03
  • iOS实现手势解锁操作

    iOS实现手势解锁操作

    这篇文章主要为大家详细介绍了iOS实现手势解锁操作功能,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-03-03
  • IOS中微信小程序播放缓存的音频文件的方法

    IOS中微信小程序播放缓存的音频文件的方法

    本文给大家分享的是如何在微信小程序中播放缓存到本地的音频文件的方法,区分了IOS和安卓的不同策略,非常不错,推荐给大家
    2017-12-12
  • iOS获取当前连接的WiFi以及IP地址

    iOS获取当前连接的WiFi以及IP地址

    本文主要介绍了iOS获取当前连接的WiFi以及IP地址方法的核心代码。具有很好的参考价值,下面跟着小编一起来看下吧
    2017-03-03
  • IOS  手势操作详解及实例总结篇

    IOS 手势操作详解及实例总结篇

    这篇文章主要介绍了IOS 手势操作详解及实例总结篇的相关资料,需要的朋友可以参考下
    2017-01-01
  • iOS开发之在列表上方添加水印的方法

    iOS开发之在列表上方添加水印的方法

    这篇文章主要给大家介绍了关于iOS开发之在列表上方添加水印的相关资料,文中给出了详细的示例代码供需要的朋友们参考学习,对大家的学习或工作具有一定的参考借鉴价值,下面随着小编来一起学习学习吧
    2018-08-08

最新评论