第一種基本的寫法和我們平時的多行注釋很相似
/**
注意,這裡多了乙個*
這裡就是我們的文件內容
*/func
somefunc
(name: string)
-> string
效果如下圖:
新增注釋
第二種和我們的單行注釋相似
/// 單行的文件注釋,只能寫一行,
////// 換行的話需要再新增三個/,同樣換行的話需要插入空行,三個/不能少
另一種新增方式
這裡的內容是用markdown的語法來書寫的,下面我們就來看看怎麼書寫:
markdown語法
同樣,我們也可以為注釋新增以下內容:
**如下:
/**
# 乙個#是一級標題
## 兩個是二級標題
### **標題
#### 四級標題
##### 五級標題
- 可以使用兩個'*'或者兩個'_'來新增粗體文字,例如:*
*粗體文字**,或者: __粗體__
- 新增鏈結的方式為[鏈結名稱](url位址),
- 新增: ![名稱](url)
- ![swift](
*/func somefunc2(name: string) -> string
效果:
swift中//mark的使用
的
Xcode文件注釋使用總結
xcode作為ios的開發神器,為我們提供了十分豐富的文件提示功能,在開發過程中,我們可以十分方便的按下option鍵,選中乙個類或者方法檢視其文件說明。而實際開發過程中我們也可以使用規範的方法新增注釋,達到這樣的效果。本篇主要介紹幾種常用的文件注釋方法。多行注釋文件 多行注釋文件相比於普通多行注釋...
Xcode注釋快捷鍵失效
我這裡注釋快捷鍵失效和目前網上看到的絕大多數情況是不一樣的。很多人遇到的情況是之前公升級xcode8造成的,說是蘋果為了解決ghost遮蔽了外掛程式導致注釋快捷鍵失效。而我是公升級了mac系統,公升級到了 macos high sierra 版本10.13 beta 但xcode仍為我之前使用的8....
Xcode 8 0無法注釋的問題
本次xcode更新,其實蘋果自己新增了類似於vvdocument 標註的功能,並且快捷鍵是command 注意之前command 是注釋一行 的,不是寫標註的,所以是快捷鍵的問題,我們可以在command 來修改快捷鍵 綠色部分的就是注釋和標註的快捷鍵了,紅色標出來的是標註的快捷鍵也就是類似於vvd...