บทความ IT เจ๋งๆ

การเขียน Clean Code น่าจะเป็นเป้าหมายของ Programmer/Developer ทุกคน แม้มันจะไม่ง่ายนัก แต่ถ้าหากรู้เทคนิค บวกกับการฝึกฝนที่เพียงพอ ก็น่าจะไม่ยากเกินไปที่จะทำ วันนี้ทีมงานจึงมี 6 เคล็ดลับ สำหรับการเขียน Clean Code ซึ่งเขียนโดย Alex Devero มาฝากกันครับ

ก่อนจะไปเข้าเรื่องเคล็ดลับของการเขียน Clean Code เรามาดูกันก่อนว่า การเขียน Clean Code มันมีประโยชน์อย่างไรบ้าง

1. ง่ายต่อการกลับมาทำใหม่

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

2. ดีต่อทีมงานที่เกี่ยวข้อง

ต่อจากข้อที่แล้ว ถ้า Project ที่ทำเป็น Project ใหญ่และเร่งด่วนมาก มีโอกาสสูงที่ต้องเพิ่ม Developer ใหม่เข้ามาในทีม แน่นอนว่าพวกเขาก็ต้องมานั่งไล่ดู Code ใหม่ ถ้า Code มีความยุ่งเหยิง อ่านยาก ทำความเข้าใจได้ยาก คิดดูว่าคนใหม่จะต้องใช้เวลามากแค่ไหน ต่อให้มีคนในทีมมาช่วยประกบ ก็คงช่วยได้แค่ไม่นาน เพราะทุกคนล้วนมีงานต้องรับผิดชอบ แต่ถ้าเป็น Clean Code ปัญหาจะลดลงมาก ทุกอย่างจะง่ายและเร็วขึ้นเยอะ

3. ง่ายต่อการทำงานไปในทางเดียวกัน

เวลาทำงานเป็นทีม แต่ละทีมคงมีแนวทางทางหรือสร้าง Standard เพื่อให้ทุกคนเขียน Code ในรูปแบบเดียวกัน แต่ถ้ามี Developer คนใดคนหนึ่งไม่ทำตามแนวทางที่ทีมวางไว้ล่ะ ทางเลือกแรกคือ ทุกคนในทีมจะผลักดันให้ Dev. คนนั้นทำตาม Standard ของทีม(ถ้ายังอยากทำงานในทีมนี้) ทางเลือกที่ 2 คือ ถ้า Dev. คนนั้นมีวิธีที่เขียน Code ที่ดีกว่าที่ทีมวางไว้ คนในทีมก็ควรปรับมาใช้แนวทางของ Dev. คนนั้น ทางเลือกสุดท้าย(ซึ่งไม่อยากให้เกิด)คือ ต่างคนต่างยึดวิธีของตัวเอง ซึ่งเป็นไปได้ว่า Dev. คนนั้นอาจตัดสินใจออกจากทีมไปเอง ดังนั้นวิธีที่ดีที่สุดคือ ทั้งทีมควรพิจารณาปรับและหาแนวทางที่ดีกว่าอยู่เสมออย่ายึดติดมากจนขาดการพัฒนา

เคล็ดลับการเขียน Clean Code

หากคุณได้ลองทำตามเคล็ดลับเหล่านี้แล้ว Code ของคุณจะอ่านและเข้าใจได้ง่ายขึ้น ซึ่งอาจไม่จำเป็นต้องทำได้ทั้งหมดทุกข้อ แค่ทำได้สัก 1-2 ข้อเป็นอย่างน้อย ก็น่าจะเห็นผลลัพธ์ที่ดีขึ้นกว่าเดิม

1. ทำให้คนอื่นอ่าน Code ง่ายขึ้น

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

2. ใช้ชื่อตัวแปร, Functions และ Methods ที่มีความหมาย

สิ่งที่ Clean Code ควรมีคือ การตั้งชื่อ ตัวแปร, Function และ Method ให้สื่อความหมาย คำว่าตั้งให้มีความหมายในที่นี้คือ ตั้งชื่อแล้ว “คนอื่น” ที่มาอ่าน Code คุณ สามารถเข้าใจได้ว่าหมายความว่าอย่างไร ไม่ใช่แค่คุณหรือคนเขียนเข้าใจได้เพียงคนเดียว

3. แต่ละ Function และ Method ควรทำหน้าที่เพียง 1 อย่าง

เมื่อก่อน Alex เองมักใช้การตั้งชื่อ Function และ Method ที่ไม่ค่อยสื่อนัก ซึ่งเรื่องนี้ทำให้เขารู้ว่า 1) การเลือกชื่อดีๆ ที่เหมาะนั้นไม่ใช่เรื่องง่าย 2) ไม่มีใครนอกจาก Alex ที่รู้ว่า Function และ Method นั้นใช้ทำอะไร 3) บางครั้ง Function เหล่านั้นก็ยากที่จะคาดเดา เพราะเขียนแล้วดูยุ่งเหยิง

จากนั้นก็มีคนแนะนำให้เขาสร้าง Function และ Method ที่ทำหน้าที่อย่างเดียวให้ชัดเจนไปเลย ทำให้ได้ผลลัพธ์ที่น่าทึ่งคือ เขาสามารถเขียน Code ที่ Clean มากขึ้นกว่าเดิม แล้วคนอื่นๆ ก็เข้าใจ Code ของ Alex และใช้เวลาอ่าน Code เพียงไม่นานก็เข้าใจ ดังนั้น การสร้าง Function หรือ Method ให้ทำหน้าที่ของมันเพียงอย่างเดียว จะทำให้ Code นั้น Clean ขึ้น

4. มี Comment เพื่ออธิบายให้ชัดเจน

ไม่ว่าคุณจะตั้งชื่อ ชื่อตัวแปร, Function และ Method ที่มีความหมายมากแค่ไหน ก็อาจมี Code บางส่วนที่อาจเข้าใจยาก ดังนั้น การอธิบายเพิ่มเติมใน Code นั้นๆ จะเป็นการช่วยให้เข้าใจ Code นั้นมากขึ้น รู้ว่าทำไมถึงเขียน Code แบบนี้และเขียนเพื่ออะไร บางทีการมี  Comment ไว้จะช่วยทำให้แก้ปัญหาได้ง่ายและไวขึ้น แถมคนที่มาอ่าน Code จะได้ไม่ต้องมาคาดเดาเอาเอง อีกอย่าง การมี Comment จะง่ายต่อคนอื่นที่จะนำ Code ไปพัฒนาหรือปรับปรุงให้ดีขึ้นกว่าเดิมอีกด้วย

5. เน้นเรื่อง Consistency

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

6. มีการ Review Code อยู่เสมอ

แม้คุณจะเขียน Clean Code เสร็จแล้ว แต่อย่าลืมว่าแม้จะเป็น Clean Code ก็ยังต้องมีการ Maintenance ด้วย ดังนั้น คุณควรมีการ Review Code อยู่เสมอ ทำให้มัน Clean ขึ้นและมีการปรับปรุงให้ดีขึ้น เพราะถ้าเราไม่ทำแบบนั้น มันก็อาจจะล้าสมัยหรือไม่ Work ในวันใดวันหนึ่งก็ได้ ยิ่ง Code ที่เราใช้งานเป็นประจำ Code เหล่านี้จะมีแนวโน้มที่จะซับซ้อนและยุ่งเหยิงมากขึ้นไปตามกาลเวลา ดังนั้นวิธีที่ดีที่สุด คือการ Review Code อย่างสม่ำเสมอนั่นเอง

หวังว่าเคล็ดลับ 6 ข้อนี้น่าจะเป็นประโยชน์ให้เหล่า Programmer/Developer ให้ลองนำไปปฏิบัติกันได้ ถ้าคุณพยายามทำให้ Code ของคุณ Clean จนติดเป็นนิสัย มันจะดีต่อตัวคุณเองแน่นอน และที่สำคัญมันก็เป็นคุณสมบัติหนึ่งที่หัวหน้างานมักคาดหวังจาก Programmer/Developer

ที่มา:  https://hackernoon.com/

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

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

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

• 4 Features ที่ควรมีใน Low-Code Development Platforms
• ข้อผิดพลาดของ Junior Developer พร้อมวิธีหลีกเลี่ยง
• วิธี Debug Web Apps โดยไม่ใช้ Browser