ในบทช่วยสอนนี้ เราจะเรียนรู้เกี่ยวกับคู่มือสไตล์มาตรฐานที่ควรปฏิบัติตามในโครงการ Python การปฏิบัติตามแนวทางมาตรฐานของภาษาการเขียนโปรแกรมใด ๆ จะทำให้สมาชิกในทีมทุกคนมีความเร็วเท่ากัน แถมยังดูเป็นมืออาชีพอีกด้วย
สำหรับ Python ผู้ใช้ส่วนใหญ่ปฏิบัติตามคำแนะนำสไตล์ PEP 8 รหัสดูสวยและอ่านง่ายขึ้น คุณสามารถดูรายการคู่มือสไตล์ทั้งหมดได้ที่นี่ เรากำลังนำเสนอรายการไกด์สไตล์ที่คัดสรรมาอย่างดีในบทความนี้
ใช้แท็บสำหรับการเยื้อง
การใช้ แท็บ สำหรับการเยื้องในโค้ดทำให้โค้ดอ่านง่ายขึ้นแทนที่จะใช้ช่องว่างแบบสุ่มสำหรับฟังก์ชันและวิธีการที่หลากหลาย คุณสามารถกำหนดจำนวนช่องว่างสำหรับแท็บในการตั้งค่าของโปรแกรมแก้ไขโค้ดใดก็ได้
คุณสามารถดูตัวอย่างด้านล่าง
# example def sample(random): # statement 1 # statement 2 # ... return random
การเข้ารหัส UTF-8 หรือ ASCII เริ่มต้นของ Python
การใช้ UTF-8 default เริ่มต้นของ Pythons หรือ ASCII การเข้ารหัสเป็นแนวทางปฏิบัติที่ดีที่สุดสำหรับสภาพแวดล้อมระหว่างประเทศ
เครื่องหมายจุลภาคต่อท้ายใน tuples
การใช้เครื่องหมายจุลภาคต่อท้ายในทูเพิลเป็นหนึ่งในแนวทางปฏิบัติที่ดีที่สุด แต่ก็ไม่ได้บังคับ
# example tup = (1, 2, 3,)
การใช้ docstrings
ใช้ docstring ในฟังก์ชันและคลาส เราสามารถใช้เครื่องหมายคำพูดสามอันสำหรับเอกสารประกอบ ดูตัวอย่างด้านล่าง
def sample(): """This is a function""" """ This is a function """ class Smaple: """This is a class""" """ This is a class """
อย่าเขียนเกิน 79 อักขระในบรรทัด
ไม่แนะนำให้เขียนอักขระเกิน 79 ตัวในบรรทัดเดียวใน PEP 8 คู่มือสไตล์ หลีกเลี่ยงสิ่งนี้โดยแบ่งบรรทัดออกเป็นหลายบรรทัดโดยใช้ อักขระหลีก () . ดูตัวอย่างด้านล่าง
# example def evaluate(a, b, c, d): return (2 ** (a + b) / (c // d) ** d + a - d * b) \ - (3 ** (a + b) / (c // d) ** d + a - d * b)
การใช้ช่องว่าง
เป็นแนวทางปฏิบัติที่ดีที่สุดวิธีหนึ่งในการใช้ช่องว่างก่อนและหลังโอเปอเรเตอร์ ใช้ช่องว่างหลังลูกน้ำเพื่อให้อ่านง่ายขึ้น
# example import random result = random.randint(1, 3) + random.randint(1, 2)
การตั้งชื่อตัวแปร ค่าคงที่ คลาสและฟังก์ชัน
ปฏิบัติตามกรณีเดียวกันสำหรับตัวแปร ค่าคงที่ คลาส และฟังก์ชันทั่วทั้งโปรแกรม ผู้ใช้ Python ส่วนใหญ่จะใช้ snake_case สำหรับการตั้งชื่อฟังก์ชันและตัวแปรและ PascalCase สำหรับการตั้งชื่อชั้นเรียน สำหรับค่าคงที่ ให้ใช้อักษรตัวพิมพ์ใหญ่ทั้งหมดที่คั่นด้วยเครื่องหมายขีดล่าง (เช่น:- PI_TWO )
snake_case => this_is_function
PascalCase => ThisIsClass
คงที่ => This_IS_CONSTANT
นำเข้าทีละโมดูล
อย่าพยายามนำเข้าหลายโมดูลในโมดูลเดียว แม้ว่าจะถูกต้องตามหลักไวยากรณ์ก็ตาม ดูตัวอย่างด้านล่าง
# don't import math, random # do import math import random
อัปเดตความคิดเห็น
ให้ความคิดเห็นของคุณเป็นปัจจุบันเสมอ อย่าลืมอัปเดตความคิดเห็นขณะอัปเดตโค้ด เป็นหนึ่งในสิ่งที่สำคัญที่สุดในการเข้ารหัส และผู้ใช้ส่วนใหญ่จะลืมมันไป จำสิ่งนี้ไว้
อักขระที่ไม่ควรใช้เป็นชื่อตัวแปรเพียงอย่างเดียว
เรามีอักขระบางตัวที่ไม่ควรใช้เป็นชื่อตัวแปรอย่างโดดเดี่ยว และพวกมันคือ I(i ตัวพิมพ์ใหญ่) และ l (L ตัวพิมพ์เล็ก) เนื่องจากมีลักษณะคล้ายกับตัวอักษรโรมัน
อย่าใช้อักขระ ASCII ในตัวระบุ
ใช้ ASCII อักขระในตัวระบุไม่ใช่แนวปฏิบัติที่ดีเลย หลีกเลี่ยงการใช้
