การเขียนโค้ดได้ กับเขียนโค้ดได้ดีนั้นต่างกันมาก เพราะการเขียนโค้ดที่ดีจริงจำเป็นต้องทำให้อ่านและเข้าใจง่ายทั้งตัวคุณเอง,ทีมงาน, หรือแม้แต่บุคคลภายนอกที่อาจต้องเข้ามาทำงานกับโค้ดของคุณด้วย ดังนั้น โปรแกรมเมอร์ควรระลึกถึงแนวทางการเขียนโค้ดที่ทำให้คนอ่านแฮ็ปปี้ ไม่คิดอยากฆ่าคนเขียนไว้ดังต่อไปนี้
• ใส่รายละเอียดประกอบหรือคอมเมนต์
แม้จะดูน่าเบื่อ แต่ถ้าคิดอยากให้คนอื่นเข้าใจโค้ดก็กรุณาเขียนคำอธิบายในโค้ดด้วย การเขียนคอมเมนต์ยังทำให้ตัวเองจำได้และมองภาพได้รวดเร็วว่าโค้ดแต่ละส่วนสำหรับไว้ทำอะไรบ้าง และพยายามเขียนคอมเมนต์เพื่ออธิบายว่าโค้ดนี้ “ทำอะไร” มากกว่าเขียนอย่างอื่นที่ไม่เกี่ยวข้องและเสียเวลาอ่าน
• ใช้ตัวแก้ไขโค้ดหรือเอดิเตอร์ที่เหมาะสม
ไม่ใช่เอะอะใช้ notepad ที่ไม่ช่วยจัดหน้าหรือเช็คความถูกต้องของคำสั่งอะไรให้เลยการใช้ตัว Editor ที่ดีจะช่วยจัดรูปย่อหน้าให้อ่านโค้ดได้ง่าย รวมทั้งอำนวยความสะดวกในการดีบั๊ก ลองพิจารณาใช้ทูลเอดิเตอร์ยอดนิยมทั้งหลายอย่าง VS Code, Vim, Atom, Notepad++,หรือ Sublimeเป็นต้น
• บันทึกการเปลี่ยนแปลงโค้ด
พร้อมเหตุผลในรูปเวอร์ชั่นอย่างเป็นระบบไม่ใช่แก้ไฟล์เดิมไปเรื่อยๆ โดยไม่สำรองหรือทำทะเบียนแต่ละเวอร์ชั่นให้เป็นระบบ ใครจะไปรู้ว่าเครื่องที่กำลังแก้โค้ดเกิดแฮงค์ขึ้นจนไฟล์เจ๊งกระทันหันก็เป็นได้ เวลาแก้ไขจนได้โค้ดที่เสถียร รันได้ไม่มีปัญหาแล้ว ให้เก็บสำรองไฟล์เป็นแต่ละเวอร์ชั่น หรืออาจจะใช้ระบบควบคุมเวอร์ชั่นโปรแกรมแบบโอเพ่นซอร์สอย่าง Git ก็ได้
• ตั้งชื่อตัวแปรให้เข้าใจ
แค่ปรายตามองโดยวางแผนเกี่ยวกับโครงสร้างชื่อตัวแปรที่อธิบายตัวเองได้ง่ายและดีที่สุด หลีกเลี่ยงการตั้งชื่อแบบมักง่ายหรือเข้าใจเองคนเดียว (เข้าใจเฉพาะตอนเขียน พอผ่านไปสักพักตัวเองก็ลืมว่าหมายถึงอะไรบ้าง) อย่าง var1, var2, บลาๆ ให้ตั้งชื่อที่อธิบายได้ในตัวเองภายในความยาวที่กระชับที่สุด
• ทำเอกสารคู่มือแยกต่างหาก
แม้จะเป็นงานลากเลือดพอสมควร แต่ถ้าการเขียนคอมเมนต์แทรกไปตามโค้ด รวมถึงการตั้งชื่อตัวแปรให้เข้าใจง่ายขึ้นนั้นไม่สามารถอธิบายให้บุคคลที่เกี่ยวข้องเข้าใจได้เพียงพอแล้ว ก็อาจจำเป็นต้องเขียนคู่มือที่อธิบายวิธีการใช้โค้ดแยกเป็นไฟล์ต่างหากด้วย
• ถ้าโค้ดทำงานได้ดีแล้ว อย่าไปยุ่งกับโค้ดเวอร์ชั่นนี้อีก
ให้คัดลอกเพื่อแก้เป็นอีกเวอร์ชั่นเวลาอยากจะแก้หรือทดลองอะไรเพิ่มเติม เพราะแทนที่โค้ดจะมีอะไรดีขึ้น ก็อาจทำให้เกิดบั๊กจนพังทั้งโปรแกรมก็เป็นได้ และพยายามระลึกว่าคุณสามารถกด Ctrl+Z ได้ตลอดเวลาแก้ไขอะไรพลาด “ถ้ายังไม่ปิดหน้าต่างตัวแก้ไขโค้ด”
ทริคข้างต้นนั้นเป็นเพียงแค่ยอดภูเขาน้ำแข็งเท่านั้น พวกโปรแกรมเมอร์ในตลาดแรงงานทั้งหลายต่างมีแนวทางปฏิบัติอีกมากมายที่แสดงถึงความเป็นมืออาชีพ และไม่ใช่ว่าทุกคนจะเหมาะกับทุกข้อที่กล่าวมา แต่ถ้าคุณได้ลองทำตามก็จะเริ่มเห็นว่าตัวเองเขียนโค้ดได้ง่ายกว่าเดิมมากขึ้นแน่นอน
ที่มา : Technotification
