التعليقات السطرية
الدرس 7 من 28 في دورة Clean Code - كتابة كود أفضل باستخدام Python على Coddy.
تشرح التعليقات المضمنة عبارة برمجية واحدة في جزء من الكود.
- اكتب التعليقات المضمنة في نفس السطر الذي توجد فيه العبارة التي تشير إليها.
- افصل التعليقات المضمنة بـ مسافتين أو أكثر عن العبارة البرمجية.
- تبدأ بـ
#ومسافة واحدة. - لا تستخدمها لشرح الأمور البديهية.
على سبيل المثال،
result = check(name) # التحقق مما إذا كان الاسم جيداًفي معظم الأوقات، ستفضل استخدام كتل التعليقات بدلاً من التعليقات المضمنة.
التحدي
سهللقد تم تزويدك بكود صغير يقوم بعملية حسابية بسيطة لزيادة الـ salary، اكتب تعليقاً في نفس السطر يشرح هذا السطر.
ربما يكون هذا شرحاً بديهياً، ولكن من أجل التدريب سنقوم بذلك...
جرّب بنفسك
salary = 1000
salary = salary * 1.05