จากการสังเกตของฉันการปฏิบัติทั่วไปคือ: อย่าลบรหัส เพียงแสดงความคิดเห็นและเก็บไว้
การปฏิบัติของฉันคือการแสดงความคิดเห็นออกมาในขณะที่แทนที่ (ส่วนใหญ่ใช้สำหรับการอ้างอิง) จากนั้นให้ลบออกในขั้นตอนสุดท้ายของการเปลี่ยนแปลงการทำงาน (สิ่งนี้ต้องการการควบคุมเวอร์ชันและความเข้าใจในวิธีการคืนค่าการเปลี่ยนแปลง)
เมื่อฉันพบรหัสความคิดเห็นเก่าฉันพยายามที่จะลบมันในการกระทำที่แยกต่างหากกับความคิดเห็นที่เหมาะสม สิ่งนี้ทำให้ง่ายต่อการย้อนกลับหรือตรวจสอบการเปลี่ยนแปลงในกรณีที่จำเป็น
สำหรับการเปลี่ยนแปลงทั้งหมดคุณควรจะสามารถใช้ประวัติการแก้ไขเพื่อพิจารณาผู้พัฒนาที่สร้างรหัส (ประวัติการแก้ไขที่มีคำอธิบายประกอบช่วยไว้ที่นี่) ติดต่อพวกเขาหากเป็นไปได้เพื่อดูสาเหตุที่รหัสเป็น ในหลายโครงการเวลาการทำความสะอาดจะไม่เกิดขึ้นและสิ่งต่างๆจะถูกทิ้งไว้เบื้องหลัง ตรวจสอบตัวติดตามบั๊กเพื่อดูว่ามีการบันทึกข้อมูลการล้างข้อมูลที่จำเป็นหรือไม่ การเปลี่ยนแปลงบางครั้งจะต้องมีการทำความสะอาดปล่อยหรือสองในภายหลัง
หากคุณกำลังเปลี่ยนรหัสควรมีเหตุผลที่คุณทำงานกับรหัสนั้น ตรวจสอบกับผู้พัฒนาดั้งเดิมเพื่อดูว่าทำไมรหัสจึงเป็นเช่นนั้น หากมีเหตุผลที่ถูกต้องที่จะไม่แก้ไขให้เพิ่มความคิดเห็นเพื่ออธิบายว่าทำไมมันถึงไม่ได้รับการแก้ไขหรือทำไมไม่ควรเปลี่ยน วิธีนี้จะช่วยให้นักพัฒนาซอฟต์แวร์รายต่อไปได้ซักครั้ง
แท็กเช่น FixMe, ToDo, Bug และ Hack สามารถใช้เพื่อระบุรหัสซึ่งสามารถเปลี่ยนแปลงได้ในภายหลัง (เป็นที่ยอมรับในการติดแท็กข้อ จำกัด เป็น Bug และไม่แก้ไขหากไม่ได้รับการกระตุ้นภายใต้เงื่อนไขที่กำหนด) อาจเป็นข้อผิดพลาดหากโปรแกรมบัญชีที่บ้านล้นที่ 20 ล้านดอลลาร์ แต่ฉันจะไม่เสียเวลาแก้ไขมากนัก มัน.
นักพัฒนาดั้งเดิมควรทำการเปลี่ยนแปลงการตรวจสอบรหัสหากเหมาะสมที่จะแก้ไขรหัส