快捷導(dǎo)航

提高Python代碼可讀性的5個(gè)技巧分享

更新時(shí)間：2022年08月24日 11:16:48 作者：zhouluobo

Python?中有許多方法可以幫助我們理解代碼的內(nèi)部工作原理，良好的編程習(xí)慣，可以使我們的工作事半功倍！本文為大家總結(jié)了五個(gè)技巧，希望有所幫助

1. Comments

我們可以對(duì)我們的代碼做的第一件事是為我們的代碼添加某些注釋?zhuān)菂s不能過(guò)度使用它。注釋?xiě)?yīng)該告訴你為什么代碼可以工作或者為什么某事以某種方式完成，而不是它是如何工作的。

Python 中的注釋通常使用井號(hào) (#) 來(lái)完成，并且可以跨越單行或多行。

# Comment using the hashtag
# Another comment using the hashtag

對(duì)于多行注釋?zhuān)覀円部梢允褂萌齻€(gè)雙引號(hào)。

"""
This is an example of
a multi-line comment
"""

在下面的示例中，代碼中添加了一些注釋?zhuān)越忉屇承┐a行背后的工作流程和推理

2. Explicit Typing

Python 語(yǔ)言是動(dòng)態(tài)類(lèi)型的，這意味著變量類(lèi)型只會(huì)在運(yùn)行時(shí)檢查。此外，變量可以在代碼執(zhí)行期間更改類(lèi)型。

另一方面，靜態(tài)類(lèi)型涉及明確說(shuō)明變量是什么類(lèi)型，并且在代碼執(zhí)行期間不能更改。

2014 年，PEP 484 引入了類(lèi)型提示的概念，后來(lái)在 Python 3.5 版本中引入，這些允許我們明確說(shuō)明變量應(yīng)該是什么類(lèi)型。

通過(guò)添加類(lèi)型提示，可以顯著提高代碼的可讀性。在下面的例子中，我們可以輕松得到如下信息：

函數(shù)需要兩個(gè)參數(shù)
文件名參數(shù)應(yīng)該是字符串類(lèi)型
start_depth 參數(shù)應(yīng)該是 float 類(lèi)型，默認(rèn)值為 None
該函數(shù)將返回一個(gè) pandas DataFrame 對(duì)象

我們可以立即根據(jù)類(lèi)型提示準(zhǔn)確判斷函數(shù)需要什么以及它將返回什么。

3. Docstrings (Documentation Strings)

文檔字符串是緊跟在函數(shù)或類(lèi)定義之后的字符串文字，Docstrings 是一個(gè)很好的方式來(lái)詳細(xì)解釋我們的函數(shù)做什么，它需要什么參數(shù)，它會(huì)引發(fā)的任何異常，它會(huì)返回什么等等。

此外，如果我們使用 Sphinx 之類(lèi)的工具為代碼創(chuàng)建在線(xiàn)文檔，則文檔字符串將自動(dòng)被拾取并轉(zhuǎn)換為適當(dāng)?shù)奈臋n。

下面的示例顯示了一個(gè)名為 clay_volume 的函數(shù)的文檔字符串。

在這里，我們可以指定每個(gè)參數(shù)是什么，這比基本的類(lèi)型提示更加詳細(xì)，我們還可以包含有關(guān)函數(shù)背后的方法的更多信息，例如學(xué)術(shù)參考或方程式。

當(dāng)我們從代碼中的其他地方調(diào)用函數(shù)時(shí)，擁有文檔字符串也是非常有幫助的。例如，使用 Visual Studio 編輯代碼時(shí)，可以將鼠標(biāo)懸停在函數(shù)調(diào)用上，然后查看該函數(shù)的功能及其要求的彈出窗口。

如果使用 Visual Studio Code (VSCode) 來(lái)編輯我們的 Python 代碼，可以使用像 autoDocstring 這樣的擴(kuò)展插件來(lái)簡(jiǎn)化創(chuàng)建文檔字符串的過(guò)程。該插件允許我們輸入三個(gè)雙引號(hào)并自動(dòng)填充模板的其余部分，我們只需要關(guān)注必須填寫(xiě)的其他詳細(xì)信息即可。

4. Readable Variable Names

很多時(shí)候，當(dāng)我們編寫(xiě)代碼時(shí)，不會(huì)太在意變量的名稱(chēng)，尤其是當(dāng)我們急于完成某些功能時(shí)。但是如果我們的代碼返回一系列名為 x1 或 var123 的變量，那么可能任誰(shuí)都無(wú)法第一眼理解它們所代表的含義。

下面的示例，我們有兩個(gè)變量 f 和 d?？梢酝ㄟ^(guò)查看代碼的其他部分來(lái)猜測(cè)這些含義，但這需要一定的時(shí)間，尤其是在代碼很長(zhǎng)的情況下。

如果我們?yōu)檫@些變量分配適當(dāng)?shù)拿Q(chēng)，就能夠知道其中一個(gè)是由 lasio.read() 調(diào)用讀取的 data_file，并且很可能是原始數(shù)據(jù)，data 變量告訴我們這是我們正在使用的實(shí)際數(shù)據(jù)。