【Python基礎 01】注釋

注釋的作用

單行注釋（行注釋）

多行注釋（塊注釋）

使用用自己熟悉的語言，在程式中對某些代碼進行标注說明，增強程式的可讀性

以 <code>#</code> 開頭，<code>#</code> 右邊的所有東西都被當做說明文字，而不是真正要執行的程式，隻起到輔助說明作用

示例代碼如下：

為了保證代碼的可讀性，<code>#</code> 後面建議先添加一個空格，然後再編寫相應的說明文字

在程式開發時，同樣可以使用 <code>#</code> 在代碼的後面（旁邊）增加說明性的文字

但是，需要注意的是，為了保證代碼的可讀性，注釋和代碼之間 至少要有 兩個空格

如果希望編寫的 注釋資訊很多，一行無法顯示，就可以使用多行注釋

要在 Python 程式中使用多行注釋，可以用 一對 連續的 三個 引号(單引号和雙引号都可以)

注釋不是越多越好，對于一目了然的代碼，不需要添加注釋

對于 複雜的操作，應該在操作開始前寫上若幹行注釋

對于 不是一目了然的代碼，應在其行尾添加注釋（為了提高可讀性，注釋應該至少離開代碼 2 個空格）

絕不要描述代碼，假設閱讀代碼的人比你更懂 Python，他隻是不知道你的代碼要做什麼

在一些正規的開發團隊，通常會有 代碼稽核 的慣例，就是一個團隊中彼此閱讀對方的代碼

<code>Python</code> 官方提供有一系列 PEP（Python Enhancement Proposals） 文檔

其中第 8 篇文檔專門針對 Python 的代碼格式 給出了建議，也就是俗稱的 PEP 8

文檔位址：https://www.python.org/dev/peps/pep-0008/

谷歌有對應的中文文檔：http://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_style_rules/

任何語言的程式員，編寫出符合規範的代碼，是開始程式生涯的第一步