هل هناك أي معايير وممارسات أساسية لصنع كود قابل للقراءة البشرية؟

Question

بشكل أكثر تحديدًا ، جعل HTML و Java و Python أكثر قابلية للقراءة؟ هل لدى أي شخص اقتراحات لطالب البرمجة؟

Answer 1

1. استخدام غلاف ثابت وتسمية.

2. استخدم علامات التبويب (والأقواس المتاحة) لتوفير تدفق بصري.

3. استخدم التعليقات التي تفسر ما يحدث من الناحية المفاهيمية والفنية. (على سبيل المثال ، // هل لدينا مستخدم صالح؟ لا // تحقق من أن user_id ليس -1)

أنا متأكد من أن بعض المطورين المتمرسين سيكون لديهم المزيد من الاقتراحات ، ولكن هذه هي أفضل 3 لي.

Answer 2

البندقية السليمة والتعليقات المفيدة.

Answer 3

استخدم المسافة البادئة والتعليقات واتفاقيات الترميز (للتحقق من Python PEP8 )

Answer 4

تأكد من أن الكود الخاص بك منظم بشكل جيد (المسافة البادئة المناسبة ، والخطوط الفارغة لفصل أقسام الكود ، وما إلى ذلك) واستخدام أسماء متغيرة قياسية ومتسقة ومسمى بالكامل (بدلاً من عدم وجود اختصار).

قد يقترح الآخرون استخدام التعليقات المناسبة. أود أن أميل إلى الاختلاف. إذا تم تنظيم الكود الخاص بك جيدًا ومتغيرات تم تسميتها جيدًا ، فستكون التعليقات مجرد تفكيك. الاستثناء من القاعدة التي تتمثل في أن تفعل شيئًا غير بديهي للعمل حول خطأ في مكان آخر (اضطررت إلى اللجوء إلى هذا في WCF و CHITITY Framework Code في الماضي).

Answer 5

حاول قراءة الكود بصوت عالٍ (أو على الأقل في رأسك).

Answer 6

ألق نظرة على هذا الكتاب: رمز نظيف: كتيب من الحرفية البرمجيات الرشيقة. الأمر كله يتعلق بجعل التعليمات البرمجية قابلة للقراءة ومفهومة.

Answer 7

نصيحة واحدة لا يجب أن تكون كسول مع أسماء. على سبيل المثال ، إذا كان لديك فئة Java وهي تنفيذ لواجهة المحولات ، وتتحول String ل Date, ، لا تتردد في تسمية الفصل StringToDateTransformerImpl.

Answer 8

حسنًا ، يمكنك دائمًا استخدام "الاختبار الجاهل". أظهر الكود الخاص بك لشخص لا يعرف شيئًا على الإطلاق عن البرمجة. إذا كان بإمكانه رؤية ما تفعله الوظيفة أكثر أو أقل ، فمن المحتمل أن يكون الكود قابلاً للقراءة.

Answer 9

يمكن أن يكون المسافة البادئة المناسبة عند كتابة HTML المنقذ ، خاصة عندما تتفاعل مع أي نوع من العناصر المتداخلة. فقط كن متسقًا مع المسافة البادئة وتأكد من تحديث الخطوط المحيطة عند تحريكه أو حذفه عنصرًا بادئًا. هذا يجعل من الأسهل بكثير تحديث الصفحة ، لأن مستوى المسافة البادئة سيعطي فكرة عن المكان الذي تكون فيه في الصفحة دون اللجوء إلى نوع من المناورة Ctrl+F.

تجدر الإشارة أيضًا إلى أنه إذا كنت تستخدم CSS بالتزامن مع HTML ، فإن التسمية المناسبة أمر بالغ الأهمية! سيحسن سير العمل الخاص بك وسهولة قراءة الكود الخاص بك.

أنا أيضًا معجب كبير بالمسافة البادئة والتباعد والتعليقات عند كتابة رمز "حقيقي" (Java ، Python ، C ، إلخ). أميل نحو (x + 1) فوق (x + 1) لأنني شخصياً أعتقد أنه يحدث فرقًا كبيرًا في قابلية القراءة. أنا أخرج من الممثلين ، والزيادات ، وما إلى ذلك ، وهم يلفت انتباهي بسهولة أكبر. كن متسقًا مع أسلوبك/المسافة البادئة ، والتعليق بشكل حر - تذكر أن إعادة كتابة اسم الطريقة ليست تعليقًا!