Apple开发_Swift语言地标注释

1、前言

• 随着编码过程深入，工程代码量会增加，任何在这大量的代码中能快速找到需要方法或者是刚才修改过代码呢？
• 在Swift代码中使用地标注释，然后就可以使用Xcode工具在代码中快速查找了；
• 地标注释有助于在大量的代码中能快速找到需要方法或者是刚刚修改过代码位置。

2、地标注释

• ① MARK: 用于方法或函数的标记注释。
  • // MARK: MARK地标注释
• ② TODO: 表示这里代码还没有完成或存在问题未解决，后期还需要处理。
  • // TODO: TODO地标注释
• ③ FIXME: 表示这里的代码曾经被修改过，标注被谁修改，以及修改原因。
  • // FIXME: FIXME地标注释
• ④ !!!: 表示标示处代码需要注意。
  • // !!!: !!!地标注释
• ⑤ ???: 表示对此处的代码有疑问。
  • // ???: ???地标注释

3、注意事项⚠️

• ① 双斜杆不能少；
• ② 字母要大写；
• ③ 冒号不能少；
• ④ 冒号之后有一个空格；
• ⑤ 需要分割线加"-"号，"-"号之后还要一个空格。

4、效果

// MARK: 用于方法或函数的注释。
// TODO: 表示这里代码没有完成，还要处理。
// FIXME: 表示这里修改了代码。
// !!!: !!!地标注释。
// ???: ???地标注释。
// MARK: - 分割线演示。