1. 程式人生 > >Python:編碼風格

Python:編碼風格

約定程式碼格式有助於讓自己的程式碼易於閱讀,讓程式碼易於閱讀有助於自己掌握程式是做什麼的,也可以幫助他人理解自己編寫的程式碼(編碼風格)

需要同時匯入標準庫中的模組和自己編寫的模組時,先編寫匯入標準庫模組的import語句,再新增一個空行,然後編寫匯入自己編寫的模組的import語句。在包含多條import語句的程式中,這種做法讓人更容易明白程式使用的各個模組都來自何方(編碼風格)

對於每個類,都應緊跟在類定義後面包含一個文件字串。這種文件字串簡要地描述類的功能,並遵循編寫函式的文件字串時採用的格式約定。每個模組也都應包含一個文件字串,對其中的類可用於做什麼進行描述(編碼風格)

每個函式都應包含簡要的闡述其功能的註釋,該註釋應緊跟在函式定義後面,並採用文件字串格式。文件良好的函式讓其他程式設計師只需閱讀文件中的描述就能夠使用它:他們完全可以相信程式碼如描述的那樣執行;只要知道函式的名稱、需要的實參以及返回值的型別,就能在自己的程式中使用它(編碼風格)

類名的駝峰命名法,所謂駝峰命名法,即將類名中的每個單詞的首字母都大寫,而不使用下劃線。例項名和模組名都採用小寫格式,並在單詞之間加上下劃線。當然,所有的這些命名都應該是具有描述性的,因為描述性名稱可幫助自己和別人明白程式碼想要做什麼(編碼風格)