xcode作為ios的開發神器，為我們提供了十分豐富的文件提示功能，在開發過程中，我們可以十分方便的按下option鍵，選中乙個類或者方法檢視其文件說明。而實際開發過程中我們也可以使用規範的方法新增注釋，達到這樣的效果。本篇主要介紹幾種常用的文件注釋方法。
多行注釋文件
/**
多行注釋文件相比於普通多行注釋多了乙個星號。
在這裡可以使用markdown語法，書寫各種提示資訊
如：顯示乙個有序列表
1. 有序列表
2. 有序列表
3. 有序列表
*/
單行注釋文件
///# 標題1
///## 標題2
///hello oc，下面的空行是為了換行
/// ///hello swift
/// - 這裡使用了無序列表
/// - 使用加粗 **this**， 使用斜體 _this_
/// - 新增乙個:
方法/函式的注釋方法的注釋包括傳入引數、返回值、和異常等說明
///- parameters:
/// - value1: 第乙個傳入引數
/// - value2: 第二個傳入引數
///- returns: 返回值的說明
///- throws : 出現異常的說明
源資訊注釋這裡是提供**的作者，版權相關說明
///- authors: 開發人員 zs, cf
///- date: 15 july 當前開發時間
標籤注釋標籤注釋穿插在我們**的任意位置，我們通過xcode的類檢視來查詢標籤，可以快速定位，十分方便，常見的三種注釋標籤如下：
//mark: - 在**的某處新增乙個標籤，可以使檢視類檢視更加方便
//todo: - 將來可能會繼續編輯的部分
//fixme: - 將要修改的部分
演算法注釋演算法是相對比較複雜的方法，我們通過注釋對其進行詳盡的說明，其文件注釋使用的關鍵字如下：
/// - precondition: 前置條件
/// - postcondition: 後置條件
/// - requires: 演算法需要的資訊
/// - invariant: 迴圈不變數
/// - complexity: 複雜度
/// - important: 描述重要資訊
/// - warning: 描述警告資訊
/// - attention: 描述注意事項
/// - note: 一些記錄
xcode 自動新增注釋，生成文件
一 自動生成注釋 新增乙個快捷鍵，生成 注釋 1 開啟thisservice，進行以下配置 name 右鍵選單中的名字 script 將doxygen.rb拖拽到這裡 2 開啟系統偏好設定，找到鍵盤，進行以下配置 這裡我將快速文件注釋的快捷鍵設定成了command option 3 使用 選中需要注...
技術總結 swift文件注釋總結
作為乙個有 潔癖的猿類，對整潔的注釋必須要強迫症，xcode為我們提供了十分豐富的文件提示功能，在開發過程中，我們可以十分方便的按下option鍵，選中乙個類或者方法檢視其文件說明。而實際開發過程中我們也可以使用規範的方法新增注釋，達到這樣的效果。本篇主要介紹幾種常用的文件注釋方法。多行注釋文件相比...
xcode 高階花樣注釋
第一種基本的寫法和我們平時的多行注釋很相似 注意,這裡多了乙個 這裡就是我們的文件內容 func somefunc name string string 效果如下圖 新增注釋 第二種和我們的單行注釋相似 單行的文件注釋,只能寫一行,換行的話需要再新增三個 同樣換行的話需要插入空行,三個 不能少 另一...