في مجال البرمجة، تعد التعليقات إحدى الطرق القليلة للحفاظ على الأفكار للمستقبل. يمكن أن تساعدك في استعراض مقتطفات التعليمات البرمجية ويمكن أن تكون مفيدة للمطور التالي الذي سيحاول فهم ما كتبته قبل أيام. إذا كنت تستخدم Visual Studio Code (VS Code)، فليست هناك حاجة لكتابة محددات التعليقات بلا كلل في كل مرة. يحتوي VS Code على ميزة اختصار مضمنة توفر ثوانٍ (وحتى دقائق) من وقتك.
اختصار تعليق رمز VS السريع
لأولئك الذين هم في عجلة من أمرهم، إليك تذكرتك الذهبية:
- للحصول على تعليق من سطر واحد، استخدم مجموعة المفاتيح Ctrl + / على نظام التشغيل Windows أو Linux أو Cmd + / على جهاز Mac. ,
- للحصول على تعليق جماعي، استخدم Shift + Alt + A على نظام التشغيل Windows أو Linux أو Shift + Option + A على جهاز Mac بدلاً من ذلك. ,
- للتعليق على التعليمات البرمجية، يمكنك الضغط على Ctrl + K + C على نظام Windows أو Cmd + K + U على نظام Mac. ,
يعلق معظم المبرمجين كثيرًا. ولا يتعلق الأمر فقط بترك تعليقات فعلية، ولكن ربما الأهم من ذلك هو أنك ستقوم بالتعليق وإلغاء التعليق. وهذا قابل للتطبيق للاختبار والتجريب وتصحيح الأخطاء.
هناك اختصارات لجعل هذا أكثر قبولا. إنها تعمل على تسريع عملية التنقل والتعديل، مما يسمح لك بتبديل التعليقات دون تعطيل زخم البرمجة.
التعليق خارج الأساسيات
على الرغم من أن الاختصارات الأساسية هي هدية حقيقية، إلا أن هناك الكثير للتعليق على VS Code. دعونا نتعمق أكثر:
تبديل التعليقات
أفضل جزء في اختصارات تعليقات VS Code هو ميزة التبديل الخاصة بها. لا تحتاج إلى العبث وإزالة كل علامة تعليق يدويًا إذا غيرت رأيك (أو أثناء تصحيح الأخطاء). وبدلاً من ذلك، يمكنك فقط استخدام نفس الاختصارات. باستخدام نفس مجموعات المفاتيح، يمكنك التبديل بسرعة بين التعليمات البرمجية المُعلق عليها وغير المُعلقة لتبقى منظمًا عندما تكون في أمس الحاجة إليها.
التعليق على أسطر متعددة
إذا كنت بحاجة إلى تجاهل مجموعة طويلة من التعليمات البرمجية أو ترك تعليق شامل ومفصل، فلن ترغب في قضاء الوقت في إضافة التعليقات سطرًا تلو الآخر. لذا، بدلاً من ذلك، يمكنك تحديد الأسطر التي تريد إلغاء تنشيطها واستخدام اختصار التعليق للسماح لـ VS Code بإدراج التعليقات في كل سطر.
التعليقات المتداخلة
في بعض الأحيان، قد يؤدي إدراج التعليقات في مقطع التعليمات البرمجية إلى نتائج وأخطاء غير متوقعة إذا لم تتطابق المحددات بشكل جيد. هذا هو المكان الذي يمكن أن يساعدك فيه Intellisense الخاص بـ Visual Studio Code. سيقوم بضبط تنسيق التعليق لك حتى داخل الكتلة التي تم التعليق عليها بالفعل، لذلك لن يكون هناك تعارض مع التعليقات المتداخلة.
كيفية رفع مستوى الصوت على airpods
ملحقات للتعليق الفائق
VS Code هو محرر مفتوح المصدر يعمل كمنصة للمطورين لتقديم أفضل أعمالهم الإضافية. يمتلئ السوق بالإضافات لتمنحك المزيد من القوة والفائدة عند التعليق:
تعليقات أفضل
قد يبدو التعليق جزءًا صغيرًا واختياريًا من البرمجة، ولكن هناك العديد من الطرق الإبداعية لاستخدام التعليقات. ال تعليقات أفضل يساعدك الامتداد على إضافة الهدف والوضوح إلى التعليقات التي تنشرها من خلال تصنيفها إلى تنبيهات واستعلامات ومهام مهام وفئات أخرى. وهذا كله مع الميزة الإضافية المتمثلة في الترميز اللوني لتحسين الرؤية والتنظيم. تصبح تعليقاتك بمثابة نقاط إرشادية وفواصل تجعل التعليمات البرمجية الخاصة بك أكثر دقة وسهولة في الوصول إليها.
مراسي التعليق
مراسي التعليق اجعلك مرتكزًا على التعليمات البرمجية الخاصة بك من خلال النقاط الدقيقة التي تميز الأقسام أو النقاط الأساسية بداخلها. إذا جربت هذا الامتداد، فسوف يتيح لك العثور بسرعة على الملاحظات والملاحظات الدقيقة. إذا كان مشروعك كبيرًا وكانت التعليمات البرمجية الخاصة بك مكتظة ويصعب متابعتها، فقد يجعل ذلك الأمر أكثر قابلية للهضم.
Polishcode
Polishcode يحول التعليمات البرمجية والتعليقات الخاصة بك إلى صور مثيرة للاهتمام بصريًا وسهلة القراءة وقابلة للمشاركة ومثالية لوسائل التواصل الاجتماعي. يتيح لك تغيير الحجم ورمز اللون وتغيير الخلفية والمزيد. يمكنك الاستفادة من سهولة القراءة بشكل أكبر، ويمكن لأي زميل في الفريق التعاون ومشاركة الرؤى بسهولة أكبر.
لماذا التعليق؟
التعليق ليس مجرد مربع لوضع علامة عليه أو بعض الأعمال الروتينية الاختيارية التي يقوم بها الأشخاص كثيرو الكلام؛ إنه جزء لا يتجزأ من البرمجة. وفيما يلي بعض الأسباب لذلك:
وضوح
يسعى المبرمجون إلى جعل الأمور المستعصية مفهومة. قد تكون كتابة التعليمات البرمجية الناجحة في بعض الأحيان أكثر وضوحًا من كتابة التعليمات البرمجية التي يسهل فهمها ومتابعتها. التعليقات هي بوصلة المطورين - وهي أداة مساعدة لا تقدر بثمن للتنقل عبر مساحات كبيرة من التعليمات البرمجية، سواء كانت خفيفة وحديثة أو كثيفة وناضجة. ربما تتعامل مع خوارزميات معقدة أو عمليات تجارية غامضة. على أية حال، توفر التعليقات عروة مألوفة في بحر من التعقيد.
تعاون
تكون التعليقات مفيدة عندما تكون مطورًا منفردًا. ولكنها ضرورية عند العمل كفريق إذا كنت ترغب في تحقيق مشروعك أي تقدم. وفي إطار جهد تعاوني، تسمح التعليقات للعديد من المطورين بالعمل معًا بسلاسة حتى في حالة عدم التفاعل. يتعين على أعضاء الفريق شرح الكود ومشاركة عمليات تفكيرهم والمنطق وراء قراراتهم. وهذا بمثابة جسر يسمح للجميع بأن يكونوا على نفس الصفحة مع المشروع ومع بعضهم البعض.
تصحيح الأخطاء
إذا وجدت نفسك تعيد النظر في التعليمات البرمجية القديمة أو تحاول تصحيح شيء يحيرك، فإن التعليقات تصبح نعمة إنقاذك. إنهم يحتفظون بسجل لمنطقك السابق وعملية التفكير التي يمكن أن توجهك إلى المنطق المعيب المحتمل وقد تعيدك إلى أصول الخطأ. باستخدام هذا التذكير بالمكان الذي كنت فيه في الماضي، يمكنك التراجع عن التغييرات التي بها مشكلات، وتحسين التعليمات البرمجية القديمة، والعودة إلى المسار الصحيح.
نصائح للتعليق الفعال
الآن أنت تعرف كيفية استخدام اختصارات التعليق، والحصول على بعض الامتدادات الإضافية الملائمة، وفهم السيناريوهات عندما يكون التعليق هو الأكثر فائدة. كل ما تبقى لك هو أن تفكر في بعض أفضل ممارسات التعليق، وستكون قد تخرجت من دورة برمجة التعليقات.
كن موجزا
هناك مهارة فنية في ترك تعليقات موجزة وسهلة الفهم. اترك ما يكفي فقط لمنح نفسك أو أعضاء فريقك في المستقبل الفكرة الصحيحة، ولكن ليس بالقدر الذي قد يكون مربكًا. يجب أن يكون لكل كلمة في تعليقك غرض وتساعد في بناء الرسالة التي تحاول إيصالها. إذا كان تعليقك مختصرًا جدًا، فقد يفشل في إيصال رسالته، ولكن إذا كان طويلًا جدًا، فمن المرجح أن تتجاهله أو تربكه في المستقبل.
تجنب التعليقات الواضحة
يجب أن تكون الملاءمة هي اهتمامك الأساسي في إنشاء تعليمات برمجية واضحة ومفهومة. إذا كنت قد كتبت الكود الخاص بك بالفعل بحيث يكون معناه واضحًا، فلا داعي لذكر شيء يمكن رؤيته للوهلة الأولى. اسمح للكود بالتحدث كلما أمكن ذلك واستخدم التعليقات لإضافة سياق إضافي أو تقديم وجهات نظر جديدة.
استخدم التعليقات لـ 'لماذا' وليس 'ماذا'
يوضح الكود الخاص بك حقائق ما يحدث. لكن التعليقات يمكن أن تحكي قصة أعمق. أنها تنقل الدوافع وعمليات التفكير وراء قراراتك. لماذا اخترت هذه الخوارزمية على أخرى؟ ما هي المزالق التي يجب وضعها في الاعتبار؟ ربما تكون قد جربت بعض التعليمات البرمجية التي يوصي بها الكثيرون، ولكنها لم تعمل أو لم يكن أداؤها جيدًا. يمكنك نقل ما هو أكثر بكثير من مجرد تعليمات من خلال تعليقات جيدة الصياغة.
ترك تعليق
قد تكون ميزة التعليق على VS Code أكثر من مجرد وسيلة راحة. إذا استفدت منها بالكامل، فقد يكون الفرق في سهولة التنقل وفهم قاعدة التعليمات البرمجية الخاصة بك هائلاً. مع استكماله بامتدادات ذكية وإستراتيجية شاملة، يمكنك قريبًا إنشاء تعليمات برمجية موثقة جيدًا تبدو وكأنها تحفة فنية.
هل تترك العديد من التعليقات لشرح الكود الخاص بك؟ أو هل تستخدم التعليقات في الغالب لاستبعاد التعليمات البرمجية المعطلة أو التجريبية من مصحح الأخطاء؟ أخبرنا بقصتك في التعليقات أدناه. انهم هنا لتبقى.