代碼的命名約定對代碼的提高可讀性影響巨大。本文中,我們将總結并向您提供一些關于命名的最佳實踐的示例,以幫助您編寫更優雅的Python代碼,使将來可能閱讀和使用您的代碼的人(包括您自己)受益。
Python是一種面向對象的程式設計語言。這意味着您将在任何給定的Python項目中建立、命名和使用各種對象。我們的命名約定是命名所建立對象的經驗法則。了解這些約定是保持代碼可讀性的重要一步。
基本命名約定
讓我們從最常見的Python對象命名開始。以下是命名的基本方法:
單小寫字元
通常用于函數中的局部變量,如x或i;
單大寫字元
通常用于命名矩陣;
小寫單詞
最常見的對象命名約定;
帶下劃線的小寫單詞
與小寫單詞的用法相同,但用于更複雜的名稱;
大寫單詞
用于單個單詞的靜态變量;
帶下劃線的大寫單詞
用于多個單詞的靜态變量;
單詞首字母大寫(又名大小寫)
這種約定是每個單詞首字母大寫,它們之間沒有空格或下劃線。用于命名類;
混合類型
從一個小寫單詞開始,然後是其他每個單詞首字母大寫。這種約定主要在Java中使用,而在Python中使用較少
以上每種約定都有不同的使用情況。這些約定不僅僅是為了美觀,而且還可以幫助您在代碼中建立有意義的對象。
要避免使用的名稱
以下是編寫Python代碼時要避免的約定。
一是我們要避免使用在某些字型中,和數字“1”和“0”無法區分的名稱,這使得使用者很難了解。二是還應該避免使用Python關鍵字和内置的類/函數名作為變量名。例如,“max” 、“sum” 、“class” 和“list” 等詞是任何Python環境中已經存在的。将它們用于其他用途可能會使代碼運作變得混亂。
子產品和包
子產品是用于執行某些任務的預建構函數和其他對象的集合。子產品應該有簡短的小寫名稱。如果子產品名提高了可讀性(比如使用了多個單詞的名稱),那麼可以在子產品名中使用下劃線。
包類似于包含子產品和其他對象的目錄。Python包應該遵循相同的約定,盡管不鼓勵在包名中使用下劃線。
變量和函數
在Python中,變量和函數的名稱應該是小寫的。需要時可以用下劃線分隔單詞。這将提高代碼的可讀性。類的方法命名應遵循與函數名相同的約定。
以下是命名變量和函數時要遵循的一些最佳實踐:
常量應該用大寫字母表示,必要時可用下劃線隔開;
使用代表對象含義的名稱,而不是無意義的單詞名稱;
應保留名稱i、j和k以表示索引值;
了解并采用這些最佳實踐是提高您的編碼技能的一個很好的方法。