Python中什么情況下需要使用注釋?zhuān)?/h1>

更新時(shí)間:2021-08-25 來(lái)源:黑馬程序員 瀏覽量:

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

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

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

3. 對(duì)于 不是一目了然的代碼，應(yīng)在其行尾添加注釋?zhuān)榱颂岣呖勺x性，注釋?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 篇文檔專(zhuān)門(mén)針對(duì) Python 的代碼格式 給出了建議，也就是俗稱(chēng)的 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/

猜你喜歡：

Python基本語(yǔ)法：注釋

什么是注釋?zhuān)縅ava中的注釋都有哪幾種？

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

上一篇：Python中怎樣改變集合之間的關(guān)系？ 下一篇：如何搭建Kerberos環(huán)境？

最新資訊

• 有哪些頁(yè)面置換算法?

  2024-05-22

• 如何解決Redis的并發(fā)競(jìng)爭(zhēng)Key問(wèn)題?

  2024-05-22

• varchar和char的使用場(chǎng)景?

  2024-05-22

• 協(xié)程為何比線程還快?

  2024-05-17

• TIME_WAIT過(guò)多是因?yàn)槭裁?

  2024-05-17

• range和xrange的區(qū)別是什么?

  2024-05-17

相關(guān)閱讀

• Python中怎樣改變集合之間的關(guān)系？

  2021-08-10

• 什么是切片？切片的語(yǔ)法格式是怎樣的？

  2021-08-10

• 小白快速掌握CDH安裝與部署

  2021-08-09

• Python程序執(zhí)行原理是什么？Python解釋器執(zhí)行哪些操作？

  2021-08-06

• 怎樣使用CLI調(diào)動(dòng)Hive功能？【CLI的使用】

  2021-08-06

• Hadoop集群初體驗(yàn)——經(jīng)典單詞統(tǒng)計(jì)案例

  2021-08-06

分享到：