Skip to main content

注釋

· One min read
Charles Wang
DevOps / Backend Engineer

在程式語言中「注釋」都是很有用的功能。 隨著程式愈來愈長、愈來愈複雜,就需要在程式碼中加上說明註釋, 大致描述程式解決問題的方法。

如何編寫注釋​

Python中,井字符號(#)標識出注釋的內容,井字符號後面的內容都會被Python 直譯器忽略:

# Say hello to everyone.
print("Hello Python people!")

Python 直譯器會忽略第1行,只執行第2行的指令。

Hello Python people!

要寫出什麼樣的注釋​

編寫注釋的主要理由是用來解釋程式碼是要做什麼的,並說明是怎麼讓它運作的。 當正在開發專案中,可能很能掌握理解專案的各部份並知道怎麼整合, 但時間一久,再回到專案中有些細節可能就忘了,雖然能透過研讀程式碼重新對專案的了解, 但若在程式碼中編寫了好的注釋,以清楚的口言來描述專案的內容,這樣可以讓我們省下很多時間。

如果想要成為專業的程式設計師,或與其它程式設計師一起協同工作,就要編寫出有意義的注釋。