التعليقات في الكود كوسيلة للتعبير عن الذات

في الآونة الأخيرة ، باختيار إطار واحد غير شائع جدًا ، صادفت قطعة التعليمات البرمجية التالية.


لأن الروبوتات القاتلة تحب حيدات!

لا أعرف ما هو التفكير وما هو المزاج الذي أراد المؤلف أن ينقله ، لكن هذا دفعني إلى التفكير: كم مرة نستخدم التعليقات ليس تمامًا للغرض المقصود؟ يجد القليل تحت القطع.

  // لا يوصى بقراءة ما إذا كنت لا تحب منشورات يوم الجمعة يوم الثلاثاء. 

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

اعتراف حزين

هل سبق لك أن كتبت شيئًا كرهته بنفسك؟ هل فهمت أن القيام بذلك أمر سيء وقبيح ، لكن الظروف (متطلبات العملاء ، على سبيل المثال) كانت أقوى منك؟ حدث بعض من هذا.

  // هذا الرمز سيء ، أنت تعرفه وأنا أعلم ذلك.
 // تحرك واتصل بي لاحم لاحقا. 

هذا الرمز مثير للاشمئزاز ، أنت تعرفه وأنا أعلمه. تقدم ، ثم اتصل بي أحمق.

  // أنا لست مسؤولاً عن هذا الرمز.
 // جعلوني أكتبها رغما عني. 

لست مسؤولا عن هذا الرمز. اضطررت إلى كتابة هذا ضد إرادتي.

  // لا بد لي من العثور على وظيفة أفضل 

حان الوقت للعثور على وظيفة أفضل

  // أخصص كل هذا الرمز ، وكل عملي ، لزوجتي دارلين ، التي ستفعل 
 // يجب أن تدعمني وأطفالنا الثلاثة والكلب بمجرد أن يحصل 
 // صدر للجمهور. 

أخصص كل هذا الرمز ، وكل عملي ، لزوجتي دارلين ، التي سيتعين عليها الاعتناء بي وأطفالنا الثلاثة والكلب بمجرد أن يرى النور.

وأحيانًا تجبرك معايير الشركة لكتابة التعليمات البرمجية على القيام بشيء لا يناسب المنطق الداخلي للمطور.

  const int TEN = 10 ؛  // كما لو أن قيمة 10 ستتقلب ... 

كما لو أن القيمة 10 يمكن أن تختلف ...

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

تحذيرات ومعرفة ضائعة

يحدث أنه من الأفضل عدم التدخل في بعض التعليمات البرمجية. لا تحاول إعادة بناءها أو تحسينها أو تحسينها بأي شكل آخر.

 / * * قد تعتقد أنك تعرف ما يفعله الرمز التالي.  * لكنك لا.  ثق بي.  * العبث بها ، وستقضي الكثير من الليالي * ليلة تشتم اللحظة التي كنت تعتقد أنك ذكي * بما فيه الكفاية "لتحسين" الشفرة أدناه.  * الآن أغلق هذا الملف وانتقل للعب مع شيء آخر.  * / 

قد يبدو لك أنك تعرف ما يفعله الرمز التالي. الأمر ليس كذلك. ثق بي. ادخل في الأمر ، وسوف تقضي الكثير من الليالي بلا نوم تشتم اللحظة التي اعتقدت فيها أنك ذكي بما فيه الكفاية "لتحسينها". الآن أغلق هذا الملف وانتقل للعب مع شيء آخر.

  / *
  * معيلنا العزيز
  *
  * بمجرد الانتهاء من محاولة "تحسين" هذا الروتين ،
  * وقد أدركت ما الخطأ الفادح الذي حدث ،
  * يرجى زيادة العداد التالي كتحذير
  * للرجل القادم.
  *
  * total_hours_wasted_here = 73
  * / 

عزيزي الشخص المرافق! عندما تنتهي من محاولتك "لتحسين" هذه العملية وأدركت مدى خطورة هذا الخطأ ، قم بزيادة العداد اللاحق كتحذير لأولئك الذين يأتون لك.

  // سحر.  لا تلمس. 

السحر. لا تلمس.

  / *
 بعد ساعات من استشارة موقع جوجل
 لقد اكتشفت ذلك بإرادة قوى مجهولة
 بدون السطر أدناه ، يعتقد IE7 أن 6 بكسل = 12 بكسل
 * /
 حجم الخط: 0px ؛ 

بعد ساعات من الاستشارة و googling ، وجدت أنه بإرادة قوى غير معروفة بدون خط لاحق ، يعتقد IE7 أن 6px = 12px

  // تم إنشاؤه تلقائيًا ، لا تقم بالتحرير.  سيتم التراجع عن جميع التغييرات. 

تم إنشاؤها تلقائيًا ، لا تقم بالتحرير. سيتم تجاهل جميع التغييرات.

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

الألم واليأس

هل كان عليك العمل مع شيء أدى بك إلى اليأس المطلق؟ واجه مطور عارض الصور Xee تحليل تنسيق PSD. ولكن مع من يستطيع المبرمج مشاركة معاناته إن لم يكن مع تعليق؟ أدناه ترجمة ، الأصل موجود حاليًا على جيثب .

هنا أود التوقف للحظة والتحدث عن تنسيق Adobe PSD. تنسيق PSD ليس بتنسيق جيد. PSD ليس تنسيقًا سيئًا. لنطلق عليه إهانة لأشكال سيئة أخرى ، مثل PCX أو JPEG. لا ، PSD عبارة عن تنسيق وحشي. أدت عدة أسابيع من العمل على هذا الرمز إلى رفع كراهيتي لـ PSD إلى مستوى حريق شديد ، مشتعل بشغف شديد من مليون شمس.

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

إن محاولة استخراج البيانات من ملف PSD يشبه البحث عن شيء في علية عمك القديم غريب الأطوار الذي مات من هجوم قرش المياه العذبة المسعور في عيد ميلاده الثامن والخمسين. التفاصيل الأخيرة ليست مهمة بشكل خاص للسرد ، ولكن في الوقت الحالي أقضي الكثير من الوقت في تقديم مصائر مثيرة للاهتمام للأشخاص المسؤولين عن هذا Ruba Goldberg بين تنسيقات الملفات.

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

PSD ليس التنسيق المفضل لدي.

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

طريقة للترفيه عن نفسك

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

  # مُهيئ شجرة عيد الميلاد  
     toConnect = []  
     لقراءة = []  
     toWrite = []   
     الأعداد = []  
     الردود = {}  
     المتبقي = {} 

مُهيئ شجرة عيد الميلاد

  ///////////////////////////////////////// هذا سطر معلق جيدًا 

علق بشكل جيد خارج الخط

  كرر
     ...
 حتى (JesusChristsReturn) `` غير متأكد 

عقيدة دينية في شك ...

  // إذا رأيت هذا مرة أخرى سأبدأ في جلب الأسلحة للعمل 

مرة أخرى سأرى هذا - سأبدأ في حمل الأسلحة للعمل

  // التخلي عن كل الأمل أيها الذين يدخلون بعد هذه النقطة 

تخلوا عن الأمل يأتون الجميع هنا

  // سكران ، أصلح لاحقًا 

إصلاح في حالة سكر في وقت لاحق

أمزح على سبيل المزاح ، وبمجرد أن تركت لنفسي ملاحظة مماثلة على ملصق على الشاشة: "Sober up - تحقق من فصول XXX ، YYY" ...

  قبض (استثناء هـ) {
  // من يهتم؟
 }} 

من يهتم؟

  // لا أفهم كيف يعمل البت التالي ، لكنه نجح في البرنامج الذي سرقته منه. 

لا أعرف كيف تعمل هذه القطعة ، لكنها نجحت في البرنامج ، من حيث سرقتها.

  // تمت كتابة هذا الرمز بواسطة عبقري ، لذا لا تحاول فهمه باستخدام
 // عقلك الصغير الصغير. 

تمت كتابة هذا الرمز بواسطة عبقري. لا تحاول فهمه بدماغك المصغر.

  اختراق مزدوج  // أوتش 

وحقاً ، أوه ...

  // تمت الإضافة لأن الرئيس غير رأيه: 20020111،20020501،20020820 ، ...
 // علق لأن رئيسه غير رأيه: 20020201،20020614،20020908 ، ... 

أضيف منذ ذلك الحين رئيسه غير رأيه ... علق ، لأنه رئيسه غير رأيه ...

  // Haleluya يمكنني العودة إلى المنزل! 

هللويا ، يمكنني العودة إلى المنزل

عدت إلى المنزل. وتخبرنا ما هو تعليقك الأكثر تميزا أو المرح.

شكرا لك على البقاء معنا. هل تحب مقالاتنا؟ هل تريد رؤية مواد أكثر إثارة للاهتمام؟ ادعمنا عن طريق تقديم طلب أو التوصية به لأصدقائك ، خصم 30 ٪ لمستخدمي Habr على نظير فريد من خوادم مستوى الدخول التي اخترعناها لك: الحقيقة الكاملة حول VPS (KVM) E5-2650 v4 (6 نوى) 10GB DDR4 240GB SSD 1Gbps من 20 $ أو كيفية تقسيم الخادم؟ (تتوفر الخيارات مع RAID1 و RAID10 ، حتى 24 مركزًا وحتى 40 جيجابايت DDR4).

ديل R730xd أرخص مرتين؟ فقط لدينا 2 x Intel Dodeca-Core Xeon E5-2650v4 128GB DDR4 6x480GB SSD 1Gbps 100 TV من 249 دولارًا في هولندا والولايات المتحدة! اقرأ عن كيفية بناء مبنى البنية التحتية الطبقة باستخدام خوادم Dell R730xd E5-2650 v4 بتكلفة 9000 يورو مقابل سنت واحد؟