كيفية كتابة التعليمات البرمجية حتى لا يقسم زملائك

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

البداية واعدة جدًا وقد شعرت بالفعل بالطلاق.

الآن ، على محمل الجد.

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

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

لذلك أعتقد أن كتابة سبب اختيار خيار يعطي مكافآت معينة.

  1. حتى لو كنت تعمل بمفردك ، يمكنك أن تفهم على الفور ما إذا كنت تعرف السبب ، لقد شعرت بالغباء عندما كتبت هذا الرمز أو كان رمزًا مناسبًا ، بالنظر إلى السياق.
  2. تكبر كمبرمج ، ويمكنك تغيير القرار الذي اتخذته من قلة الخبرة ، لأنك تعرف سبب وجوده هنا.
  3. بمرور الوقت ، فإن السبب وراء كتابة مثل هذا الرمز يمكن أن "يغرق في غياهب النسيان" والآن عندما ترى هذا ، يمكنك أن تفهم أنه يمكنك أن تتخلى عنه بعقل هادئ ، إذا لم تكتبه ، فسيظل هنا ، يخشى أن تؤذي شيئا.
  4. يمكنك إلقاء نظرة على الكود القديم المكتوب أمامك بطريقة جديدة. إذا كنت في وقت سابق ، بنظرة متعجرفة ، أنت فقط أخفقت عليه ، والآن تفهم أنه في الموقف الذي كان المبرمجون أمامك فيه ، كان هذا قرارًا صائبًا للغاية.
  5. ينقذ من الموقف عندما تنظف ، قرار العكاز الذي كان أمامك ، واتضح أنك فتحت صندوق البندورة ، لأن هذا العكاز فقط هو الذي يمنع من الموت الشامل.
  6. عندما تكتب السبب ، سيتمكّن مطور آخر يرى ذلك من إعادة الكتابة ، مع العلم بكيفية حل المشكلة التي قمت بحلها بشكل أكثر فعالية.

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

Source: https://habr.com/ru/post/ar459410/


All Articles