7 ขั้นตอน เพื่อการ Review Code ที่ดีขึ้น

21-ก.ย.-18

คัมภีร์เทพ IT

ในขั้นตอนพัฒนา Software ต้องใช้ความใส่ใจในรายละเอียด การมีคนช่วย Review Code กลายเป็นเรื่องที่จำเป็น เพราะความผิดพลาดเล็กน้อย ก็อาจส่งผลกระทบที่ใหญ่หลวงต่อ Project ได้ แม้จะมี Automated Tests ที่ช่วยตรวจสอบ Code ของคุณ แต่โดยรวมก็คงสู้มนุษย์เองไม่ได้ วันนี้ทีมงานมีบทความเกี่ยวกับ 7 ขั้นตอน เพื่อการ Review Code ที่ดีขึ้น มาฝากกันครับ

การ Review Code จะเป็นตัวที่มีผลต่อความเร็วของการพัฒนา Software คำถามที่น่าสนใจคือ หน้าที่ของผู้ที่ Review Code มีอะไรบ้าง? เมื่อทำการ Review Code คุณจะให้ข้อเสนอแนะที่มีประโยชน์ได้อย่างไร? คุณจะร้องขอ Input ที่จะช่วยเร่งและปรับปรุง Project ได้อย่างไร? เรามาดูเคล็ดลับเล็กๆ น้อยๆ ในการ Review Code กัน

1. Establish goals

การ Review Code ไม่ใช่แค่การค้นหา Error และ Bug เพียงเท่านั้น คุณยังสามารถนึกถึงการเพิ่ม Feature ใหม่ๆ และวิธี Implement มัน คุณอาจต้องทำให้แน่ใจว่า Code นั้นตรงตาม Standard Style ที่องค์กรของคุณกำหนดไว้หรือไม่ แต่ไม่ว่าเป้าหมายจะเป็นอย่างไร สิ่งสำคัญคือคุณต้องให้ความชัดเจนตั้งแต่ช่วงเริ่มต้นของ Process นี้ และทุกคนในทีมก็ต้องเข้าใจรวมทั้งทำงานตรงตามที่กำหนดได้ ถ้าสมาชิกในทีมแต่ละคนมีเป้าหมายหรือจุดยืนที่แตกต่างกัน มันก็ยากที่จะบรรลุข้อตกลงและทำให้งานคืบหน้า

2. Do your first pass

ลองทำการ Review คร่าวๆ ยังไม่ต้องทำในเชิงลึก เพียงแค่ทำในภาพรวมอย่างรวดเร็วก่อน แล้วให้ทีมงานของคุณเขียนความประทับใจในครั้งแรกและดูความคิดของพวกเขา

3. Use a ticketing system

Software Development Platforms ส่วนใหญ่ จะอำนวยความสะดวกในเรื่อง Comment และ Discussion เกี่ยวกับแง่มุมต่างๆ ของ Code อยู่แล้ว ทุกครั้งที่มีการเปลี่ยนแปลง/แก้ไข Code จะนับเป็น Ticket ใหม่ และทันทีที่สมาชิกในทีมต้องแก้ไข/เปลี่ยนแปลง Code พวกเขาก็จะสร้าง Ticket ขึ้นมา โดยใน Ticket ควรอธิบายว่า สิ่งที่แก้ไข/เปลี่ยนแปลงมีอะไรบ้าง แล้วจะไปไหนต่อ และทำไมถึงจำเป็นต้องเปลี่ยน จากนั้นสมาชิกคนอื่นในทีมก็สามารถ Review Ticket และเพิ่ม Comment ของตนเองได้ ระบบนี้ไม่เพียงช่วยคุณ Track การแก้ไข/เปลี่ยนแปลง ทั้งหมดได้เท่านั้น แต่การ Discussion ในทีม จะนำไปสู่การปรับปรุงและทำให้ Code โดยรวมดีขึ้นอีกด้วย

4. Run tests

คุณสามารถลองตรวจหา Error เล็กๆ น้อยๆ ได้โดยไล่ดู Code แต่มันจะง่ายขึ้น หากคุณ Run Code แค่เพียงบางส่วน แล้วดูว่ามันทำงานอย่างไร การทำเช่นนี้จะช่วยให้คุณสามารถหา Bug ในแง่ที่ว่ามันจะส่งผลต่อ Application ของคุณอย่างไร ได้ง่ายขึ้น อีกทั้งยังสามารถให้ข้อมูลในเชิงลึกว่า Feature ไหนที่ขาดหายไปหรือควรต้องปรับปรุงแล้ว

5. Test proposed changes

ใส่ Code ลงไปใน Testing Environment ของคุณ แล้วดูวิธีที่มันทำงานภายใต้สิ่งที่แก้ไข/เปลี่ยนแปลง มันทำงานได้ดีอยู่ไหม? Software มันถูกปรับปรุงหรือการเปลี่ยนแปลงนั้น เป็นสาเหตุให้เกิดปัญหาอื่นๆ อีกหรือไม่? การเปลี่ยนแปลงนี้ มันเหมาะสมกับ Budget โดยรวมของ Project นี้หรือไม่? ยังมีอะไรอีกบ้างที่ยังจำเป็นต้องทำ? คุณสามารถสร้าง Ticket เพิ่มสำหรับการ Discussion ได้อีกด้วย

6. Do your in-depth pass

ในขั้นตอนนี้จะเป็นการ Review เจาะลึกลงไปในรายละเอียด Code แต่ละบรรทัด และทำการหา Bug, ปัญหาเรื่อง Style, ใส่วงเล็บผิดที่/วงเล็บเปิด-ปิดไม่ครบ เป็นต้น บางคนก็ชอบที่จะทำขั้นตอนนี้ก่อนที่จะ Test ภาพรวมเบื้องต้น (ในข้อ 2) พวกเขาจะรอจนกว่าจะทำเสร็จ แล้วทำการ Test การเปลี่ยนแปลงทั้งหมดรวดเดียวเลย แต่การ Test การเปลี่ยนแปลงในครั้งแรก จะเป็นตัวช่วยให้คุณสำหรับการ Test ครั้งที่ 2 นอกจากนี้การ Test ในรวดเดียวจะช่วยให้คุณประหยัดทั้งเงินและเวลาไม่ใช่ประหยัดการ Test ทั้งหมดจนจบ

7. Submit the evaluation

หากเป็นการเปลี่ยนแปลงเล็กๆ น้อยๆ อย่าง Error ของ Code หรือ การพิมพ์ผิดพลาด คุณก็สามารถแก้ไขได้เลย แต่การเปลี่ยนแปลงที่สำคัญๆ คุณควรพูดคุยหรือปรึกษากับผู้ที่เขียน Code นั้นก่อนเสมอ เมื่อคุณส่งการประเมิน Code แล้วให้พูดคุยกับผู้เขียน Code นั้นแล้วหาเหตุผลว่าทำไมเขาถึงทำแบบนั้น จากนั้นบอกพวกเขาถึงแนวทางของคุณแล้วดูว่าพวกเขาคิดเห็นอย่างไร หวังว่าคุณจะสามารถมองเห็นบางสิ่งบางอย่างจากมุมมองของแต่ละฝ่าย และใช้ข้อมูลในเชิงลึกเหล่านั้นเพื่อสร้าง Code ที่ดีที่สุดเท่าที่จะเป็นไปได้

การ Review Code ถือเป็นหนึ่งในขั้นตอนที่สำคัญที่สุดในการเขียน Program หวังว่าขั้นตอนเหล่านี้ น่าจะเป็นประโยชน์สำหรับคนที่จะ Review Code ไม่ว่าจะเป็นของตนเองหรือที่ผู้อื่นเขียน ลองนำไปประยุกต์ใช้ดู เชื่อว่าจะทำให้ Code ของคุณมีคุณภาพดีขึ้น

ที่มา:  https://www.infoworld.com/

 

 

 

รับตำแหน่งงานไอทีใหม่ๆ ด้วยบริการ IT Job Alert

 

อัพเดทบทความจากคนวงในสายไอทีทาง LINE ก่อนใคร
อย่าลืมแอดไลน์ @techstarth เป็นเพื่อนนะคะ

เพิ่มเพื่อน

 

บทความที่เกี่ยวข้อง