Swift 基礎(chǔ)教程

Swift 運(yùn)算符

在本文中，您將了解Swift注釋?zhuān)瑸槭裁匆约叭绾问褂盟鼈儭?/p>

注釋是程序源代碼中程序員可讀的解釋或注釋。編譯代碼時(shí)，編譯器將忽略它。

注釋是為了讓閱讀代碼的人更好地理解程序的意圖和功能。在團(tuán)隊(duì)中工作時(shí)，為其他團(tuán)隊(duì)成員澄清代碼的目的可能會(huì)很有幫助，或者在單獨(dú)工作時(shí)，它可以起到提醒自己的作用。

Swift有兩種類(lèi)型的注釋?zhuān)?/p>

在Swift中，任何以?xún)蓚€(gè)斜杠 // 開(kāi)頭的行都是單行注釋?zhuān)幸詢(xún)蓚€(gè)斜杠 // 開(kāi)頭的行都會(huì)被編譯器忽略。

您可以在 playground 的頂部找到一個(gè)簡(jiǎn)單的示例：

//: Playground - noun: a place where people can play

它以?xún)蓚€(gè)斜杠 // 開(kāi)頭，并對(duì)文件提供了有意義的解釋?zhuān)纾骸癙layground - noun: a place where people can play”。

示例1：?jiǎn)涡凶⑨?/h4>

示例

//Sample program
//stores 3.14 in variable pi
let pi = 3.14159 
print(pi)

上面的示例包含兩個(gè)單行注釋?zhuān)?/p>

// Sample program
// stores 3.14 in variable pi

如果您的注釋包含多行，則可以將其括在中/*...*/。

多行注釋以正斜杠開(kāi)頭，后跟星號(hào)(/*) ，以星號(hào)結(jié)尾，后跟正斜杠(*/)。Swift 編譯器會(huì)忽略/* 和 */之間的所有內(nèi)容。

/* 這是一個(gè)多行注釋。
在您編寫(xiě)多行注釋后，添加*，后跟/以結(jié)束它
*/

示例

/* 硬編碼的 pi 值可能不那么精確。
因此，您可以使用內(nèi)置數(shù)據(jù)類(lèi)型計(jì)算更準(zhǔn)確的值
*/
let pi = Double.pi
print(pi)

上面的示例包含多行注釋。

/* 硬編碼的 pi 值可能不那么精確。
因此，您可以使用內(nèi)置數(shù)據(jù)類(lèi)型計(jì)算更準(zhǔn)確的值
*/

盡管注釋對(duì)于更好地理解所編寫(xiě)代碼的意圖很有意義。但是需要注意的是：

不要在多行中將注釋包含在//中，盡管它是有效的，并且編譯器忽略這些行。相反，應(yīng)該把它放在多行注釋/* ... */中
例如：
```
//This is a comment.
//Use it when necessary and precisely
```
以上寫(xiě)注釋的方法是正確的，但不建議這樣做，因?yàn)槿绻⑨尨笥谝恍?，則需要寫(xiě)多行注釋。更好的書(shū)寫(xiě)方式是將多行注釋用作：
```
/* This is a comment.
Use it when necessary and precisely
*/
```
單行注釋可以寫(xiě)在單獨(dú)的一行中，也可以與代碼一起寫(xiě)在同一行中。但是，建議在單獨(dú)的行中使用注釋。
例如：
```
let pi = 3.14159 //stores 3.14 in variable pi
```
這種編寫(xiě)注釋的方法是有效的。但是最好把注釋寫(xiě)在單獨(dú)一行:
```
//stores 3.14 in variable pi
let pi = 3.14159
```
即使您是一個(gè)團(tuán)隊(duì)中的單個(gè)開(kāi)發(fā)人員，并且您是唯一一個(gè)編寫(xiě)代碼的人，如果代碼沒(méi)有注釋?zhuān)埠茈y在程序中找到它的用途。所以，準(zhǔn)確地使用它，并提供一個(gè)有意義的描述。
使注釋非常簡(jiǎn)單和有意義。
不要在代碼上寫(xiě)不必要的注釋。
在大多數(shù)情況下，請(qǐng)使用注釋來(lái)解釋“為什么”而不是“如何”。