الاسم الصحيح

الدرس 5 من 28 في دورة Clean Code - كتابة كود أفضل باستخدام Python على Coddy.

عند اختيار الأسماء، ينبغي لك دائمًا اختيار أسماء وصفية تجعل شفرتك أكثر قابلية للقراءة.

def foo(x):
	return x * 2

المثال التالي غير واضح وليس سهل القراءة.

الطريقة الصحيحة،

def multiply_by_2(num):
	return num * 2

أصبحت الشفرة الآن واضحة حتى دون قراءة جسمها.

إذا كان ذلك ممكنًا ولم يكن ضروريًا، ينبغي لك تجنب الأسماء المكوّنة من حرف واحد مثل a وx وi وما إلى ذلك...

التحدي

سهل

عند اختيار اسم مناسب لدالة أو class، ينبغي أولًا أن تفهم الغرض منه وما الذي يصفه بأفضل شكل.

لديك شيفرة برمجية — أصلح الأسماء في هذه الشيفرة!

أولًا — افهم الغرض من كل جزء من الشيفرة!

بالطبع توجد إجابات ممكنة عديدة، لكننا نهدف إلى إجابات محددة..

جرّب بنفسك

class MyClass:
    def __init__(self, name, age):
        self.name = name
        self.age = age
    
    def bar(self, x, y):
        self.name = x
        self.age = y
    
    def p(self):
        print(f'My name is {self.name} and I\'m {self.age} years old')

if __name__ == '__main__':
    b = 'Bob'
    c = 32
    a = MyClass(b, c)
    a.bar(b, 33)
    a.p()