สิ่งที่น่าสนใจคือความสามารถในการอ่านที่ใช้กับภาษาธรรมชาตินั้นวัดได้จากความเร็วในการอ่านและความเข้าใจ ฉันเดาว่ากฎง่าย ๆ สามารถนำไปใช้ได้จริง ๆหากความคิดเห็นของรหัสเฉพาะไม่ปรับปรุงคุณสมบัตินี้ก็สามารถหลีกเลี่ยงได้
ทำไมต้องแสดงความคิดเห็น?
ถึงแม้ว่าความคิดเห็นของรหัสเป็นรูปแบบของเอกสารที่ฝังตัวมีหลายวิธีในภาษาการเขียนโปรแกรมระดับสูงเพื่อหลีกเลี่ยงการเขียนโปรแกรม "over-documented" ฟุ่มเฟือย (ของรหัสที่มีความหมาย) โดยใช้องค์ประกอบของภาษาเอง มันเป็นความคิดที่ไม่ดีที่จะเปลี่ยนรหัสให้เป็นรายการจากการเขียนโปรแกรมตำราเรียนซึ่งคำอธิบายแต่ละคำจะถูกอธิบายอย่างแท้จริงในลักษณะที่ซ้ำซาก (คิด "/ * เพิ่มขึ้นฉันโดย 1 * /" ตัวอย่างในคำตอบที่ให้ไว้แล้ว) เฉพาะโปรแกรมเมอร์ที่ไม่มีประสบการณ์ในการใช้ภาษา
อย่างไรก็ตามมันเป็นความตั้งใจที่จะพยายามที่จะแสดงความคิดเห็นรหัส "ภายใต้เอกสาร" (แต่ไม่มีความหมาย) รหัสที่แท้จริง "แหล่งที่มาของความชั่วร้ายทั้งหมด" การมีอยู่ของรหัส "ภายใต้เอกสาร" เป็นสัญญาณที่ไม่ดี - ไม่ว่าจะเป็นระเบียบที่ไม่มีโครงสร้างหรือแฮ็คที่แปลกประหลาดของจุดประสงค์ที่หายไปอย่างลึกลับ เห็นได้ชัดว่าค่าของรหัสดังกล่าวเป็นที่สงสัยอย่างน้อย น่าเสียดายที่มีตัวอย่างอยู่เสมอเมื่อมันเป็นการดีกว่าที่จะแนะนำความคิดเห็นในส่วนของบรรทัดโค้ดที่จัดรูปแบบ (จัดกลุ่มทางสายตา) มากกว่าห่อมันลงในรูทีนย่อยใหม่ (คิดว่า "ความมั่นคงแบบโง่เขลา" ซึ่ง " .
ความสามารถในการอ่านโค้ด! = ความคิดเห็นของโค้ด
รหัสที่อ่านได้ไม่จำเป็นต้องมีคำอธิบายประกอบ ในแต่ละสถานที่ในรหัสมีบริบทของงานที่รหัสเฉพาะนี้ควรจะบรรลุเสมอ หากวัตถุประสงค์หายไปและ / หรือรหัสทำสิ่งที่ลึกลับ = หลีกเลี่ยงค่าใช้จ่ายทั้งหมด ไม่อนุญาตให้แฮ็กแปลก ๆ เติมรหัสของคุณ - มันเป็นผลโดยตรงจากการรวมเทคโนโลยีบั๊กกี้โดยไม่มีเวลา / ความสนใจในการทำความเข้าใจพื้นฐาน หลีกเลี่ยงรหัสลึกลับในโครงการของคุณ!
ในทางกลับกันโปรแกรม readable = รหัส + เอกสารสามารถมีหลายส่วนที่ถูกต้องตามกฎหมายของความคิดเห็นเช่นเพื่ออำนวยความสะดวกในการสร้างเอกสาร "ความเห็นต่อ API"
ปฏิบัติตามมาตรฐานสไตล์โค้ด
ตลกพอคำถามไม่ได้เกี่ยวกับเหตุผลที่จะแสดงความคิดเห็นรหัสมันเป็นเรื่องเกี่ยวกับการทำงานเป็นทีม - วิธีการผลิตรหัสในรูปแบบข้อมูลให้ตรงกันสูง (ที่คนอื่นสามารถอ่าน / เข้าใจ) คุณปฏิบัติตามมาตรฐานรูปแบบรหัสใน บริษัท ของคุณหรือไม่ วัตถุประสงค์หลักคือเพื่อหลีกเลี่ยงการเขียนโค้ดที่ต้องมีการรีแฟคเตอร์มันเป็น "ส่วนบุคคล" และ "ส่วนตัว" คลุมเครือเกินไป ดังนั้นฉันเดาว่าถ้าใครเห็นความจำเป็นในการใช้สไตล์ของรหัสมีเครื่องมือที่จริงจังในการติดตั้งอย่างถูกต้องโดยเริ่มจากการให้ความรู้กับผู้คนและสิ้นสุดด้วยระบบอัตโนมัติสำหรับการควบคุมคุณภาพของรหัส (ผ้าสำลีจำนวนมาก ฯลฯ ) และ รวมการควบคุม) ระบบตรวจสอบโค้ด
กลายเป็นผู้สอนศาสนาที่สามารถอ่านรหัสได้
หากคุณยอมรับว่าโค้ดอ่านบ่อยกว่าที่เขียนไว้ หากการแสดงออกอย่างชัดเจนของความคิดและการคิดอย่างชัดเจนเป็นสิ่งสำคัญสำหรับคุณไม่ว่าจะใช้ภาษาใดในการสื่อสาร (คณิตศาสตร์รหัสเครื่องจักรหรือภาษาอังกฤษโบราณ) .. หากภารกิจของคุณคือการกำจัดความคิดทางเลือกที่น่าเบื่อและน่าเกลียด .. คนสุดท้ายมาจาก "รายการ" อื่น) .. ถามคำถามเริ่มต้นการอภิปรายเริ่มกระจายความคิดกระตุ้นหนังสือเกี่ยวกับการทำความสะอาดโค้ด (อาจไม่เพียง แต่สิ่งที่คล้ายกับรูปแบบการออกแบบของเบ็ค แต่คล้ายกับที่กล่าวมาแล้วโดย RC Martin ) ในการเขียนโปรแกรม ต่อไปเป็นหัวข้อย่อยของแนวคิดหลัก (อ้างอิงจากหนังสือของ O'Reilly เรื่องการอ่าน)
- ลดความซับซ้อนของการตั้งชื่อการแสดงความคิดเห็นและการจัดรูปแบบด้วยเคล็ดลับที่ใช้กับรหัสทุกบรรทัด
- ปรับแต่งลูปตรรกะและตัวแปรของโปรแกรมเพื่อลดความซับซ้อนและความสับสน
- ปัญหาการโจมตีในระดับฟังก์ชั่นเช่นการจัดระเบียบบล็อกของรหัสใหม่เพื่อทำงานทีละครั้ง
- เขียนรหัสทดสอบที่มีประสิทธิภาพอย่างละเอียดและรัดกุม - และสามารถอ่านได้
การตัด "การแสดงความคิดเห็น" ออกไปหนึ่งยังเหลืออยู่มาก (ฉันเดาว่าการเขียนโค้ดที่ไม่ต้องการความคิดเห็นก็คือการออกกำลังกายที่ยอดเยี่ยม! การตั้งชื่อตัวระบุที่มีความหมายเชิงความหมายเป็นการเริ่มต้นที่ดี จากนั้นจัดโครงสร้างโค้ดของคุณโดยจัดกลุ่มการดำเนินการเชื่อมต่อแบบลอจิคัลลงในฟังก์ชันและคลาส และอื่น ๆ โปรแกรมเมอร์ที่ดีกว่าคือนักเขียนที่ดีกว่า (แน่นอนว่าสมมติว่ามีความเชี่ยวชาญด้านเทคนิคอื่น ๆ )