Python中什么情況下需要使用注釋？

在注釋代碼的時(shí)候我們應(yīng)當(dāng)注意：

1. 注釋不是越多越好，對(duì)于一目了然的代碼，不需要添加注釋
   

2. 對(duì)于 復(fù)雜的操作，應(yīng)該在操作開(kāi)始前寫(xiě)上若干行注釋
   

3. 對(duì)于 不是一目了然的代碼，應(yīng)在其行尾添加注釋（為了提高可讀性，注釋?xiě)?yīng)該至少離開(kāi)代碼 2 個(gè)空格）
   

4. 絕不要描述代碼，假設(shè)閱讀代碼的人比你更懂 Python，他只是不知道你的代碼要做什么
   

   
   

在一些正規(guī)的開(kāi)發(fā)團(tuán)隊(duì)，通常會(huì)有代碼審核的慣例，就是一個(gè)團(tuán)隊(duì)中彼此閱讀對(duì)方的代碼，找出和發(fā)現(xiàn)在開(kāi)發(fā)中出現(xiàn)的錯(cuò)誤并及時(shí)訂正，預(yù)防代碼出現(xiàn)錯(cuò)誤，提高代碼的安全性。減少后期的軟件檢查。而注釋代碼就是為了給同事或者同行提供便利，以求更快的理解你寫(xiě)這行代碼的意思，知道你要做什么。
 

關(guān)于代碼規(guī)范

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

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

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

谷歌有對(duì)應(yīng)的中文文檔：http://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_style_rules/

什么是注釋？Java中的注釋都有哪幾種？

黑馬程序員Java培訓(xùn)