作為乙個有**潔癖的猿類，對整潔的注釋必須要強迫症，xcode為我們提供了十分豐富的文件提示功能，在開發過程中，我們可以十分方便的按下option鍵，選中乙個類或者方法檢視其文件說明。而實際開發過程中我們也可以使用規範的方法新增注釋，達到這樣的效果。本篇主要介紹幾種常用的文件注釋方法。
/**
多行注釋文件相比於普通多行注釋多了乙個星號。
在這裡可以使用markdown語法，書寫各種提示資訊
如：顯示乙個有序列表
1. 有序列表
2. 有序列表
3. 有序列表
*/
/**
* 多行注釋文件相比於普通多行注釋多了乙個星號。
* 在這裡可以使用markdown語法，書寫各種提示資訊
* 如：顯示乙個有序列表
* 1. 有序列表
* 2. 有序列表
* 3. 有序列表
*/
/// 文件注釋支援 markdown語法
/// # 標題1
/// ## 標題2
/// hello oc，下面的空行是為了換行
////// hello swift
/// - 這裡使用了無序列表
/// - 使用加粗 **this**， 使用斜體 _this_
/// - 新增乙個:![swift picture]
func singlelinecomment()
方法的注釋包括傳入引數、返回值、和異常等說明，函式的注釋對於團隊合作相關重要
//mark: - 在**的某處新增乙個標籤，可以使檢視類檢視更加方便
//todo: - 將來可能會繼續編輯的部分
//fixme: - 將要修改的部分
演算法是相對比較複雜的方法，我們通過注釋對其進行詳盡的說明，其文件注釋使用的關鍵字如下：
/// - precondition: 前置條件
/// - postcondition: 後置條件
/// - requires: 演算法需要的資訊
/// - invariant: 迴圈不變數
/// - complexity: 複雜度
/// - important: 描述重要資訊
/// - warning: 描述警告資訊
/// - attention: 描述注意事項
/// - note: 一些記錄
Swift文件注釋
a dome method param input an int number returns the string represents the input number func method input int string return string input 在文件注釋的塊中 在這裡是被...
Swift 文件注釋規範
的結構和組織關乎了開發童鞋們的節操問題。明確和一致的 表示了明確和一貫的思想。編譯器並沒有乙個挑剔的口味，但當談到命名，空格或文件，人類的差異就體現出來了。nshipster 的讀者無疑會記得去年發表的關於文件的文章，但很多東西已經在 xcode 6 中發生了變化 幸運的是，基本上算是變得更好了 因...
Xcode文件注釋使用總結
xcode作為ios的開發神器，為我們提供了十分豐富的文件提示功能，在開發過程中，我們可以十分方便的按下option鍵，選中乙個類或者方法檢視其文件說明。而實際開發過程中我們也可以使用規範的方法新增注釋，達到這樣的效果。本篇主要介紹幾種常用的文件注釋方法。多行注釋文件 多行注釋文件相比於普通多行注釋...