《ActionScript 3.0基礎教程》——2.3 代碼注釋

本節書摘來自異步社群《actionscript 3.0基礎教程》一書中的第2章，第2.3節，作者： 【美】doug winnie 更多章節内容可以通路雲栖社群“異步社群”公衆号檢視。

注釋是你開發過程中非常重要的部分，它可以幫助你或者你的隊友了解代碼的含義。注釋包括注意、提示、代碼解釋等。這樣其他人就能了解代碼的意思了。

就算你是獨自一人工作，注釋也能在你停止某項目一段時間後又想要傳回項目時幫助你了解曾經寫下的代碼，很多程式員會在工作時寫很複雜的代碼，當時會記得很清楚，但是在幾個月之後他們發現這些代碼的意思他們自己已經忘記了。

2.3.1　建立注釋

在flash中你有兩種建立注釋的方法。第一種是一行的注釋。這樣的注釋用"//"建立，任何在雙斜杠後面的内容（注意隻在這一行），将不會被flash執行。比如：

在這個例子裡，第一行是注釋，不會被flash所執行。

第二種類型的注釋是多行注釋。你需要使用特殊的符号放在句子的開頭和末尾來建立這樣的注釋，符号是"/"和"/"。這組符号中的所有語句将不被flash執行。比如：

在"/"和結尾"/"中間的語句将不被flash所執行，這中間的内容你想要多長都可以。你也許看見過一些代碼使用過這樣的符号，它們都有相同的作用，把符号中間的所有内容注釋掉。

2.3.2　空格的作用

通常情況下，你可以在代碼中使用空格，如空格、tab、回車。這樣做有時可以很好的排列代碼。通常我們會在一組相同意義的代碼前加入注釋。在代碼中如何很好的使用tab來規範代碼，本書會在以後的章節提到。

藍色圓圈的例子我們可以這樣來擴充一下，讓它更加的清晰、易讀：