10
วิธีการทำให้ codebase ขนาดใหญ่เข้าใจง่ายขึ้น
สมมติว่าฉันกำลังพัฒนาโครงการที่ค่อนข้างใหญ่ ฉันได้บันทึกคลาสและฟังก์ชั่นทั้งหมดของฉันกับ Doxygen แล้วอย่างไรก็ตามฉันมีความคิดที่จะใส่ "โน้ตของโปรแกรมเมอร์" ลงในไฟล์ซอร์สโค้ดแต่ละไฟล์ แนวคิดเบื้องหลังนี้คือการอธิบายในแง่ของคนธรรมดาว่าคลาสเฉพาะทำงานอย่างไร (และไม่เพียง แต่เหตุผลที่ความคิดเห็นส่วนใหญ่ทำ) กล่าวอีกนัยหนึ่งคือการให้มุมมองอื่น ๆ เกี่ยวกับการทำงานของโปรแกรมเมอร์ ตัวอย่างเช่น: /* * PROGRAMMER'S NOTES: * * As stated in the documentation, the GamepadManager class * reads joystick joystick input using SDL and 'parses' SDL events to * Qt signals. * * Most of the code here is …