ฉันเป็นหนึ่งในนักพัฒนาที่มีความคิดว่าโค้ดที่เขียนควรอธิบายตนเองและอ่านเหมือนหนังสือ
อย่างไรก็ตามเมื่อพัฒนารหัสห้องสมุดสำหรับคนอื่น ๆ ที่จะใช้ฉันพยายามที่จะนำเอกสารมากที่สุดในไฟล์ส่วนหัวเป็นไปได้; ซึ่งทำให้เกิดคำถาม: วิธีการจัดทำเอกสารที่ไม่ใช่แบบสาธารณะนั้นคุ้มค่ากับเวลาหรือไม่ พวกเขาจะไม่ใช้โดยตรงในความเป็นจริงพวกเขาไม่สามารถ ในเวลาเดียวกันถ้าฉันแจกจ่ายรหัสดิบ (แม้ว่าอย่างไม่เต็มใจ) วิธีการที่ไม่ใช่แบบสาธารณะเหล่านั้นจะสามารถมองเห็นได้และอาจต้องอธิบาย
เพียงมองหามาตรฐานและแนวทางปฏิบัติที่คุณเห็นหรือใช้ในการเดินทางของคุณ