zoukankan      html  css  js  c++  java
  • [Swift]Xcode标记:MARK、TODO、FIXME

    ★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★
    ➤微信公众号:山青咏芝(shanqingyongzhi)
    ➤博客园地址:山青咏芝(https://www.cnblogs.com/strengthen/ 
    ➤GitHub地址:https://github.com/strengthen/LeetCode
    ➤原文地址:https://www.cnblogs.com/strengthen/p/10672131.html 
    ➤如果链接不是山青咏芝的博客园地址,则可能是爬取作者的文章。
    ➤原文已修改更新!强烈建议点击原文地址阅读!支持作者!支持原创!
    ★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★

    1. MARK

    MARK一定要大写。其又叫做代码标注,我们可以使用它来添加一些说明文字。同时可以选择其上方是否需要显示分割线。

    // MARK: - 说明文字,带分割线
    // MARK: 说明文字,不带分割线
    其他标记类似:‘-’为分割线,注意‘-’右侧为空字符。
    代码示例:
     1 import UIKit
     2  
     3 class ViewController: UIViewController {
     4  
     5     override func viewDidLoad() {
     6         super.viewDidLoad()
     7     }
     8      
     9     // MARK: 业务处理相关方法(上方不带分割线)
    10     func test1() {
    11     }
    12      
    13     // MARK: - 数据请求相关方法(上方会带个分割线)
    14     func test2() {
    15     }
    16 }
    2. TODO

    当我们写代码时,如果有一些功能需要以后添加或者补全,那么就可以使用 TODO 关键字来标记提醒。

    TODO: 需要提醒的文字
     代码示例:
     1 import UIKit
     2  
     3 class ViewController: UIViewController {
     4  
     5     override func viewDidLoad() {
     6         super.viewDidLoad()
     7     }
     8 
     9     func test() {
    10         // TODO: 需要记录操作日志
    11     }
    12 }
    3. FIXME

    有时候在编程的过程中,会有一些小的bug,不紧急也不影响程序的运行,可以暂时不予处理,稍后需要修改,其用法类似TODO,只是语义有所区别。

    通常我们在 bug 的位置使用 FIXME 做标记,提醒我们稍后需要进行修改。

    FIXME: 需要修改bug的相关说明

     代码示例:

     1 import UIKit
     2  
     3 class ViewController: UIViewController {
     4  
     5     override func viewDidLoad() {
     6         super.viewDidLoad()
     7     }
     8  
     9     func test() {
    10         // FIXME: 参数不正确时会导致崩溃
    11     }
    12 }
     
  • 相关阅读:
    Java排序算法之归并排序
    Java多线程学习笔记(四)——Thread类中方法介绍
    大数据平台搭建:Hadoop
    np.arrange用法
    Pandas中DateFrame修改列名
    python .loc vs .iloc区别
    The categories of Reinforcement Learning 强化学习分类
    python3.6安装总结
    梯度下降法与牛顿下降法速度的比较
    My SQL 和SQL Server区别
  • 原文地址:https://www.cnblogs.com/strengthen/p/10672131.html
Copyright © 2011-2022 走看看