มีการศึกษาเชิงประจักษ์เกี่ยวกับผลกระทบของการคอมเม้นท์ซอร์สโค้ดต่อคุณภาพของซอฟต์แวร์ความสามารถในการบำรุงรักษาและประสิทธิภาพของนักพัฒนาหรือไม่? [ปิด]

ฉันเป็นผู้สนับสนุนให้ความเห็นเกี่ยวกับซอร์สโค้ดและการทำเอกสารผลิตภัณฑ์ซอฟต์แวร์ มันเป็นประสบการณ์ส่วนตัวและการสังเกตของฉันว่าการทำงานกับซอร์สโค้ดที่แสดงความคิดเห็นอย่างจริงจังได้ช่วยฉันในรูปแบบที่แตกต่างกันเมื่อฉันต้องเติบโตซอฟต์แวร์หรือบำรุงรักษามัน

อย่างไรก็ตามมีอีกค่ายหนึ่งที่กล่าวว่าการแสดงความคิดเห็นนั้นไร้ค่าในที่สุดหรือคุณค่าของมันนั้นน่าสงสัย ผู้เสนอการเข้ารหัสจำนวนมากโดยไม่แสดงความเห็นแย้งว่า:

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

สำหรับฉันนี่เป็นเพียงความเชื่อ อีกครั้งการสังเกตส่วนตัวของฉันคือซอฟต์แวร์ที่เขียนโดยทีมนักพัฒนาที่ชาญฉลาดและมีประสบการณ์ท้ายที่สุดก็จบลงด้วยรหัสจำนวนมากที่ไม่ได้อธิบายตัวเอง

อีกครั้งที่ Java API, Cocoa API, Android API ฯลฯ แสดงว่าหากคุณต้องการเขียนและดูแลรักษาเอกสารที่มีคุณภาพเป็นไปได้

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

ดังนั้นฉันกำลังมองหาเอกสารทางวิชาการและการศึกษาเชิงประจักษ์เกี่ยวกับผลกระทบของเอกสารประกอบซอฟต์แวร์โดยเฉพาะการแสดงความคิดเห็นซอร์สโค้ดต่อคุณภาพและการบำรุงรักษารวมถึงผลกระทบต่อประสิทธิภาพการทำงานของทีม

คุณได้สะดุดกับบทความดังกล่าวและสิ่งที่เป็นผลของพวกเขาถ้ามี?

ใน"ผลกระทบของการทำให้เป็นโมดูลและการแสดงความคิดเห็นต่อความเข้าใจในโปรแกรม" (1981), Woodfield, Dunsmore และ Shen พบว่า "วิชาที่โปรแกรมมีความคิดเห็นสามารถตอบคำถามได้มากกว่าที่ไม่มีความคิดเห็น"

อย่างไรก็ตามใน"การเรียนรู้การวัดความสามารถในการอ่านโค้ด" (2010), Raymond PL Buse และ Westley Weimer พบว่าความคิดเห็นมีผล จำกัด เฉพาะต่อความสามารถในการอ่านและคุณภาพ:

จากนามธรรม:

เราสร้างการวัดความสามารถในการอ่านอัตโนมัติและ ... แสดงให้เห็นว่าตัวชี้วัดนี้มีความสัมพันธ์อย่างยิ่งกับคุณภาพซอฟต์แวร์สามมาตรการ: การเปลี่ยนแปลงรหัสรายงานข้อบกพร่องอัตโนมัติและข้อความบันทึกข้อบกพร่อง ... ข้อมูลของเราแสดงให้เห็นว่า กว่าบรรทัดว่างธรรมดาเพื่อตัดสินการอ่านในท้องถิ่น

จากหน้า 12:

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

โปรดทราบว่าผู้เสนอ "เข้ารหัสโดยไม่แสดงความคิดเห็น" ไม่ได้บอกว่ารหัสที่ไม่มีความคิดเห็นนั้นดีกว่ารหัสที่มีความคิดเห็น พวกเขากำลังเถียงว่ารูปแบบของรหัสที่ไม่มีความคิดเห็น - หนึ่งที่แยกรหัสออกเป็นวิธีการที่มีชื่ออธิบายตนเองหนึ่งที่อธิบายตัวแปรอธิบายหนึ่งที่มีชุดทดสอบที่ดี - ดีกว่ารหัสที่ไม่ได้ทำสิ่งเหล่านั้น แต่มีความคิดเห็น สิ่งนี้อาจทำให้การบังคับใช้งานของการศึกษาใด ๆ ที่เกิดขึ้นมีความซับซ้อน