هل يجب علي كتابة التعليقات؟

خواطر حول كود التعليق والتعليق بالطريقة الصحيحة

كثيرًا ما يُقال لنا أن التعليقات مهمة جدًا. التعليقات جزء كبير ومهم من البرمجة. كمبتدئ ، من الصعب الحكم وتحديد عدد التعليقات التي يجب إضافتها وماذا تكتب في التعليقات!

هذا أحد الأشياء التي لم يتم إصلاحها في الحجر ، يبدو أن لكل شخص رأي مختلف ومتناقض ، وهذا يتركك في حالة من عدم اليقين مليئة بعدم الأمان.

هذا هو خط تفكيري:يجب عليك كتابة التعليقات ، قدر الإمكان ، لشرح قراراتك.

دعونا نحلل هذا.

يجب أن تكون الكود الخاص بك توضيحيًا ذاتيًا ، بقدر ما تستطيع.

اللغات عالية المستوى مثل JavaScript أو Python سهلة القراءة للغاية. يمكنك تقريبًا قراءة الكود بصوت عالٍ وتعتقد أنه إنجليزي عادي ، إذا سميت المتغيرات والأساليب بشكل صحيح.

ستتطلب بعض الأشياء مزيدًا من التفكير ، ولكن حتى لو كانت التعليمات البرمجية معقدة بعض الشيء ، طالما أن المبرمج يمكنه قراءتها وتحديد ما يفعله الكود بنسبة 100٪ ، فلا يجب أن يحتاج إلى تعليقات.

تحتاج إلى تعليقات عندما يتعين عليك شرحلماذا التعليمات أو كتلة معينة. ليسماذا او ما، يجب الاستدلال عليه من الكود. نسميها عالية المستوى لسبب: إنها رمز يمكننا التفكير فيه. إنها ليست لغة الآلة أو التجميع ، وهو أمر يصعب قراءته وفهمه.

ستحتاج بعض أجزاء التعليمات البرمجية إلى تعليقات لشرح البعض الآخر ، أوحتى نفسكولماذا اأنت تفعل شيئًا معينًا. ليس دائمًا بالطبع ، ليس عندما يكون واضحًا.

حتى بعد مرور 6 أشهر ، إذا كنت تعمل على جزء منفصل من قاعدة البيانات ثم عدت إلى هذا السطر من التعليمات البرمجية ، فمن المحتمل أنك لن تتذكر كل ما كان على المحك عندما قمت بتحريره. قد تتذكر 90٪ من أسباب إضافة شيء ما ، ولكن هناك شيء آخر لا يمكنك اكتشافه .. تعليق سيكون رائعًا لذلك.

الكود ليس مجرد تعليمات وتعليقات. في كثير من الأحيان يمكنك معرفة سبب إضافة سطر من التعليمات البرمجية بفضل التحكم في المصدر (شخص سخيف). أنت تبحث عن الخط في تطبيق Git الخاص بك ، وسوف يخبرك سجل هذا الخط لماذا قمت أنت أو زميلك في العمل بتعديل ذلك قبل 10 أشهر. إذا كانت رسالة Git الالتزام مفيدة ومفصلة ، وليس "إصلاح الخطأ". يعد هذا أيضًا توثيقًا جيدًا ، خاصةً في مشاريع مفتوحة المصدر التي يمكن أن يكون بها الكثير من الأشخاص الذين يلمسون قاعدة الكود.

إذا كنت في مقابلة عمل ، وسألت نفسك "هل يجب علي إضافة تعليقات في تمريني؟" الجواب دائمانعم.

هل سيحكمون عليك على الأرجح على تعليقاتك وكذلك على التعليمات البرمجية الخاصة بك. وما تكتبه في التعليقات أيضًا.

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