# 【知識精講】在程序中添加注釋 ## Part1 在前面的課程中，我們看到一些給出的代碼中一些以`//`開頭的內容，這些以`//`開頭的內容是一種用于解釋說明的信息，我們稱之為**注釋**。 在代碼比較長,或者程序設計的邏輯比較復雜的時候，我們就需要為程序寫一些注釋了。在 C/C++ 語言中，一共有兩種注釋的方式——第一種是我們已經看到的在某一行中插入`//`的形式，這行中，`//`后的所有內容將在程序編譯時被忽略，成為僅被程序員所關注的內容。我們將這種形式的注釋稱為**行注釋**。 ## Part2 在 C++ 語言中，還有另一種注釋——以`/*`作為開頭，以`*/`作為結尾。在一對`/*`與`*/`之間的所有內容都會被作為注釋的內容，只讓程序員作為參考，而在程序編譯時不被關注。我們將這種形式的注釋稱為**塊注釋**。 行注釋和塊注釋的目的其實都是一樣的，小渡在課程代碼中寫一些注釋，可以幫助你了解如何更好的學會程序；你寫一些注釋可以讓自己在之后回顧時不至忘記自己的想法，也可以讓和你一起寫程序的其他人更容易地看懂你的程序。 ## Part3 你可能會好奇：既然有兩種不同的注釋，什么時候用塊注釋、什么時候用行注釋呢？ 一般來說，對于以下兩種情況下，我們會使用塊注釋： * 需要把一大段代碼暫時性注釋掉的時候 * 使用一些會讀取代碼中塊注釋來生成文檔的工具的時候 除了以上的兩種情況，我們都建議大家使用行注釋，哪怕是連續的幾行文字，我們都依然建議你分成多個連續行注釋來進行說明，而不是使用一個跨多行的塊注釋。 ## Part4 你是不是有些懷疑小渡的說法？來讓我帶你來看一個多行注釋寫法可能造成的問題。 ~~~ int main() { cout << "Hello"; /* 說你好 */ cout << "World"; return 0; } ~~~ 對于上面給出的情況，如果我們需要暫時性注釋掉 main 函數內的前兩行代碼，我們將得到一個這樣的代碼片段： ~~~ /* cout << "Hello"; /* 說你好 */ cout << "World"; */ ~~~ 這種情況下，第一個`cout`開始前的`/*`和“說你好”后的 `*/` 將會被匹配。而編譯器將無法正常的對之后的一個`*/`進行理解。這種問題是不是我們不希望出現的呢？如果我們平時都用單行注釋，是不是就不會有這樣的問題了呢？