本節書摘來異步社群《arduino實戰》一書中的第1章，第1.7節，作者：【美】martin evans ,joshua noble ,jordan hochenbaum，更多章節内容可以通路雲栖社群“異步社群”公衆号檢視
arduino實戰
你剛剛寫了一段引以為豪的絕妙的代碼。設想一下，在6個月之後，别人在浏覽你過去的工作時看到了這段代碼，但他們卻搞不太懂這段代碼在幹什麼或者是如何工作的。一段簡單的說明在這時也許會派上大用場。在這種情況下，為你的代碼編寫注釋就非常有必要了。
為程式添加注釋有兩種方式：單行注釋和塊注釋。單行注釋的方法是在行首添加一個雙斜線（//）。這就是在告訴編譯器這隻是一段注釋，可以将它忽略。當你想将一個代碼塊作為注釋時，将這段代碼以/開頭，以/結尾即可。下面就示範了這兩種方法：
你應該在哪裡添加注釋呢？每個程式的開頭都應該有一個塊注釋，在其中說明這個程式起什麼作用，誰在什麼時間寫了這些程式以及版本号等等。下面的代碼清單就給出了一個代碼頭的示例。
代碼清單1-4 代碼頭示例
遍布代碼中的單行注釋能夠讓你快速地了解每段代碼都起什麼作用。你并不需要對每一段代碼都寫注釋，隻要添加那些你認為在日後可能會幫自己和他人了解代碼的注釋就夠了。但多寫點注釋總比一點都不寫要好。下列代碼清單展示了一些典型的代碼注釋。
代碼清單1-5代碼注釋示例
我們在這節介紹了代碼編輯器，了解了一個arduino如何由setup和loop函數構成，最後探讨了為代碼編寫注釋的必要性。