6 แนวทางการเขียนโค้ดที่ทุกคนต้องรู้
เผยแพร่แล้ว: 2019-01-22ในการออกแบบเว็บของสำนักงานกฎหมายหรือการออกแบบเว็บประเภทใด ๆ สำหรับเรื่องนั้น จำเป็นสำหรับโปรแกรมเมอร์ที่จะต้องปฏิบัติตามแนวทางการเขียนโค้ดบางชุด ซึ่งจะทำให้โครงการดำเนินไปอย่างรวดเร็วและราบรื่นยิ่งขึ้น รวมทั้งทำให้ง่ายต่อการทำความสะอาดใดๆ ข้อผิดพลาดและลดโอกาสของความผิดพลาดที่จะเกิดขึ้นในอนาคต
นี่เป็นแนวทางปฏิบัติในการเขียนโค้ดที่ทดลองและเป็นจริงซึ่งนักพัฒนาหลายคนได้เรียนรู้วิธีที่ยาก โชคดีที่ความผิดพลาด โศกนาฏกรรม และความโชคร้ายของพวกเขาเป็นประโยชน์ต่อคุณ ท้ายที่สุดพวกเขาทำผิดพลาดดังนั้นคุณไม่จำเป็นต้องทำ
ดังนั้น หากคุณปฏิบัติตามแนวทางการเขียนโค้ดทั้ง 6 แบบนี้ในการพัฒนาเว็บไซต์สำนักงานกฎหมายของคุณ คุณก็ไม่ต้องกังวลกับการสร้างคำพูดที่หยาบคายที่คนอื่นจะได้เรียนรู้จากมันในที่สุด
เยื้องที่สอดคล้องกัน
แม้ว่าการเยื้องเป็นส่วนที่สำคัญที่สุดอย่างหนึ่งของการเขียนโปรแกรมคอมพิวเตอร์ แต่ก็ไม่มีผลกับวิธีการรันโค้ดหรือขนาดของโปรแกรม ซึ่งอาจเป็นสาเหตุที่โปรแกรมเมอร์จำนวนมากไม่ปฏิบัติตามแนวทางนี้ การเยื้องที่สม่ำเสมอไม่ส่งผลต่อการรันโค้ด แต่ทำให้โปรแกรมอ่านและเข้าใจได้ง่ายขึ้น นอกจากนี้ยังทำให้ง่ายต่อการดูว่าโค้ดชุดหนึ่งสิ้นสุดที่ส่วนใดและอีกชุดหนึ่งเริ่มต้นขึ้นที่จุดใด
คุณควรฝึกการเยื้องที่สอดคล้องกันไม่ว่าจะใช้ภาษาโปรแกรมประเภทใดเพราะจะทำให้ข้ามโปรแกรมได้ง่ายขึ้นและค้นหาว่าบรรทัดของโค้ดไม่อยู่ในตำแหน่งที่ถูกต้องหรือไม่ โปรแกรมเขียนเพียงครั้งเดียว แต่มีการอ่านและอ่านซ้ำหลายครั้ง และการเยื้องที่สอดคล้องกันจะช่วยให้ผู้อ่านในอนาคตมีความชัดเจนที่จำเป็นและน่าชื่นชมมาก โดยสรุป การเยื้องที่สอดคล้องกันทำให้โค้ด:
- ง่ายต่อการอ่าน
- ง่ายๆ ให้ผู้อ่านเข้าใจ
- ง่ายต่อการระบุและแก้ไขข้อผิดพลาด
ใช้รูปแบบการตั้งชื่อที่สอดคล้องกัน
เช่นเดียวกับแนวทางปฏิบัติแรกในบทความนี้ รูปแบบการตั้งชื่อที่สอดคล้องกันยังช่วยปรับปรุงความสามารถในการอ่านโค้ดและทำให้เข้าใจได้ง่ายขึ้นมาก รูปแบบการตั้งชื่อที่ดีควรระบุอย่างรวดเร็วและชัดเจนว่าฟังก์ชันนี้ใช้ทำอะไร วิธีหนึ่งที่ดีในการทำเช่นนี้คือการใช้ภาษาธรรมชาติแทนภาษาแอสเซมบลี อ่านง่ายกว่าและคอมพิวเตอร์ยังสามารถปฏิบัติตามคำแนะนำที่เขียนในลักษณะที่เป็นธรรมชาติ
คุณควรหลีกเลี่ยงการมีชื่อเดียวครอบคลุมแนวคิดที่แตกต่างกันหลายแนวคิด หากการกระทำหรือแนวคิดแต่ละอย่างแตกต่างกัน แต่ละรายการก็ควรมีชื่อที่แตกต่างกันเพื่อแสดงถึงแนวคิดหรือการกระทำนั้น ในทางกลับกัน คุณควรหลีกเลี่ยงการมีแนวคิดเดียวที่มีชื่อต่างกันหลายชื่อ การใช้คำพ้องความหมายแทนคำเดียวกันซ้ำแล้วซ้ำเล่าเป็นแนวทางปฏิบัติที่ดีในการเขียนร้อยแก้ว แต่เมื่อเขียนโค้ด อาจทำให้สับสนและซ้ำซ้อนได้ ตัวอย่างเช่น การใช้ทั้งคำว่า "ลบ" และ "ลบ" ไม่จำเป็นเมื่อทั้งสองมีความหมายเหมือนกัน จะดีกว่าถ้าเลือกหนึ่งคำและปฏิบัติตาม
หลีกเลี่ยงการทำรังมากเกินไป
กฎทั่วไปคือคุณไม่ควรมีการซ้อนเกินสามระดับ หากคุณทำเช่นนั้น รหัสจะอ่านและจัดองค์ประกอบใหม่ได้ยาก กฎนี้สามารถหักได้หากคุณมีสี่หรือห้าระดับของการซ้อน ตราบใดที่พวกมันอ่านง่าย ที่ที่เราพบปัญหาคือเมื่อการซ้อนทำงานลึก 10 ระดับขึ้นไป จนถึงจุดที่แม้แต่จอภาพขนาดใหญ่สองจอก็แทบจะไม่มีการเขียนโค้ดที่เขียนอยู่เลย ในกรณีนี้ การทำตามกฎสำคัญอื่น: KISS หรือที่รู้จักว่า Keep It Simple Stupid
จำกัดความยาวสาย
ในอดีต กฎคือบรรทัดควรมีความยาวไม่เกินแปดสิบอักขระ แต่หลายคนรู้สึกว่ากฎนี้ล้าสมัยเนื่องจากจอภาพที่กว้างขึ้นซึ่งสามารถรองรับบรรทัดโค้ดที่ยาวได้ แม้ว่าจอภาพจะใหญ่กว่าจริง แต่จิตใจของมนุษย์ก็ยังเฉียบขาด หมายความว่า เราอ่านบรรทัดที่มีความยาวประมาณแปดสิบอักขระได้ง่ายกว่า ไม่ว่าจะในหนังสือหรือบนคอมพิวเตอร์ หน้าจอ. และตามที่ระบุไว้บ่อยครั้ง จนถึงตอนนี้ โค้ดที่ชัดเจนและอ่านง่ายเป็นที่ต้องการมากที่สุด หรือพูดแบบนี้ การอ่านโค้ด 110 บรรทัดอาจไม่เป็นปัญหาสำหรับบางคน แต่การอ่านโค้ด 80 บรรทัดไม่ใช่ปัญหาสำหรับทุกคน
แยกรหัสและข้อมูล
นี่เป็นหนึ่งในแนวทางปฏิบัติที่มักถูกท้าทายโดยนักพัฒนารุ่นใหม่ แม้ว่าจะมีการใช้งานมาหลายปีแล้วก็ตาม สาเหตุที่แนวทางปฏิบัตินี้ได้รับแรงฉุดคือมีความปลอดภัยมากกว่าเพราะป้องกันการดำเนินการของโค้ดที่เสียหายที่อาจเกิดขึ้น การแยกรหัสและข้อมูลยังช่วยให้แชร์ข้อมูลระหว่างแอปพลิเคชันและภาษาต่างๆ ได้ง่ายขึ้น
การปรับโครงสร้างโค้ด
การปรับโครงสร้างโค้ดเป็นกระบวนการของการปรับโครงสร้างโค้ดใหม่โดยไม่เปลี่ยนฟังก์ชันของโค้ดดังกล่าว นี่เป็นหนึ่งในแนวทางปฏิบัติขั้นพื้นฐานและสำคัญที่สุดในการเขียนโปรแกรม เนื่องจากคุณแทบจะไม่เคยทำให้ถูกต้องในครั้งแรกที่ออก สิ่งนี้ใช้ได้กับเกือบทุกอย่าง ดังนั้นการเขียนโปรแกรมคอมพิวเตอร์จึงไม่แตกต่างกัน และด้วยเหตุผลเดียวกันมาก
หนึ่งในนั้นคือคุณเรียนรู้เพิ่มเติมเกี่ยวกับโครงการในขณะที่คุณทำงาน ดังนั้นคุณจึงรู้มากขึ้นเมื่อสิ้นสุดโครงการมากกว่าตอนเริ่มต้น ซึ่งหมายความว่าคุณสามารถใช้ความรู้ที่มากขึ้นนั้นเพื่อเขียนใหม่หรือออกแบบโค้ดใหม่เพื่อปรับปรุง . การปรับโครงสร้างใหม่ไม่จำเป็นต้องเป็นสิ่งที่ไม่ดี ตราบใดที่มีไว้เพื่อให้ทันกับฐานโค้ดที่เปลี่ยนแปลงตลอดเวลาและเปลี่ยนแปลงตลอดเวลา
แนวทางปฏิบัติเหล่านี้ช่วยปรับปรุงความเร็วและประสิทธิภาพของคุณ
การพัฒนาเว็บไซต์ของสำนักงานกฎหมายไม่ใช่เรื่องง่าย แต่ก็ไม่จำเป็นต้องยากเกินไปเช่นกัน ตราบใดที่คุณปฏิบัติตามแนวทางการเขียนโค้ดเหล่านี้ คุณจะพบว่าผู้อื่นอ่านโค้ดของคุณได้ง่ายขึ้น คุณจะพบว่าการระบุปัญหาและการแก้ไขรหัสเพื่อแก้ไขปัญหานั้นง่ายกว่ามาก ชุดรูปแบบทั่วไปของแนวทางปฏิบัติเหล่านี้คือทำให้โค้ดอ่านง่ายขึ้นมาก ซึ่งเหมาะสำหรับทุกคนในทุกขั้นตอนของโครงการ
มีความคิดเกี่ยวกับเรื่องนี้หรือไม่? แจ้งให้เราทราบด้านล่างในความคิดเห็นหรือดำเนินการสนทนาไปที่ Twitter หรือ Facebook ของเรา
คำแนะนำของบรรณาธิการ:
- Google ทำให้การเข้ารหัส AI ง่ายขึ้นด้วย Cloud Automl
- 15 เครื่องมือทางการตลาดออนไลน์ที่จะช่วยคุณในการทำธุรกิจ
- โดรน Tello ตัวใหม่ของ Ryze Robotics สอนวิธีเขียนโค้ดให้คุณแล้ว
- รหัสในแอพคู่หูของ Red Dead Redemption 2 อาจชี้ไปที่การเปิดตัวพีซี
- Taco Playbits แบบไม่มีหน้าจอจะนำการเล่นในจินตนาการกลับคืนมาในขณะที่เรียนรู้ทักษะ STEM ที่สำคัญ