เป็นเรื่องปกติ / ยอมรับได้ที่จะจดบันทึกความคิดอัลกอริธึมการตัดสินใจระหว่างการเข้ารหัสและการบำรุงรักษาหรือไม่? [ปิด]

บางคนมีปัญหานี้ที่พวกเขาไม่สามารถคิดได้หากไม่มีคำพูด และการจดบันทึกความคิดและการตัดสินใจเป็นวิธีที่มีประสิทธิภาพที่สุดในการดำเนินการ

ดังนั้น - เป็นเรื่องปกติและเป็นที่ยอมรับหรือไม่ที่ฉันจะเขียนความคิดและการตัดสินใจลงในไฟล์ Notepad ++ บางไฟล์ระหว่างการเข้ารหัส?

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

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

ไม่เพียงเป็นเรื่องปกติ แต่เป็นความคิดที่ดี

มีคำพูดที่มีชื่อเสียง

"ให้เวลาฉันหกชั่วโมงเพื่อตัดต้นไม้และฉันจะใช้ขวานสี่คมแรก"

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

ใช่มันเป็นที่ยอมรับอย่างสมบูรณ์และเป็นเรื่องปกติ

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

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

มันเป็นความคิดที่ดี จนกระทั่งมันกลายเป็นหนทางในการผัดวันประกันพรุ่ง

กุญแจสำคัญคือความสมดุล ฉันพบว่าฉันทำงานได้ดีที่สุดถ้าฉันไม่ทำกล่องของตัวเอง แต่เก็บความคิดเมื่อพวกเขามา

ถ้าฉันบดในระดับต่ำและความคิดระดับสูงมาฉันแค่จดไว้แล้วกลับมาในภายหลัง

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

ในสถานการณ์ระดับมืออาชีพไม่เพียง "ปกติและยอมรับได้" เท่านั้น วงจรการพัฒนาทั่วไปประกอบด้วยสองขั้นตอนเอกสารก่อนที่จะเริ่มการเข้ารหัสใด ๆ :

1. เอกสารข้อกำหนดด้านการใช้งาน:เขียนโดยนักวิเคราะห์ธุรกิจระบุหน้าที่การใช้งาน

2. รายละเอียดการออกแบบเอกสาร:ซึ่งเป็นสวยมากสิ่งที่คุณกำลังพูดถึงเพียงแค่เป็นทางการมากขึ้นระบุสลายการทำงาน (แฟ) ของระบบอัลกอริทึม ฯลฯ บาง (มาก) คนเก่าของฉันออนไลน์อยู่เช่นนี้

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

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

นอกเหนือจากคำตอบที่ดีอื่น ๆ ฉันจะเสริมว่าฉันมักจะเขียนความคิดของฉันเกี่ยวกับสิ่งที่ฉันพยายามทำ

การมีความชัดเจนมากเกี่ยวกับการสื่อสารสิ่งที่ฉันพยายามทำช่วยให้ฉันเข้าใจสมมติฐานข้อสันนิษฐานและ / หรือข้อกำหนดที่ไม่จำเป็นต้องมี

จากนั้นบอกทางเลือกซึ่งฉันสามารถครุ่นคิดดีกว่ากันในทางกลับกัน; การเขียนนั้นช่วยประหยัดสถานที่ของฉันถ้าฉันคิดอย่างอื่น

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

การจดบันทึกทุกสิ่งที่สามารถช่วยคุณ / (ใหม่) เวลาที่สมาชิกในทีมใช้เวลาอย่างคุ้มค่า ตรวจสอบให้แน่ใจว่าเป็นสิ่งที่บางคนอาจต้องการในภายหลังและไม่ต้องคิดนอกเสียจากว่าจะเป็นโครงการระยะยาวที่แท้จริง

นอกจากนี้ยังไม่ควรใช้เวลาใด ๆ หากคุณใช้เวลาคิดว่าคุณสามารถเขียนความคิดของคุณลง 1 ถึง 1 (ตราบเท่าที่พวกเขาจะ / มีประโยชน์กับใครบางคน)

ปัญหาที่แท้จริงอาจเป็นการคิดในสิ่งที่คุณเขียน เพียงเพราะคุณกำลังเขียนไม่ได้หมายความว่าคุณจะต้องปฏิบัติตามรูปแบบที่มีอยู่แล้วบางส่วนหรือต้องไปตลอดทางในการสร้างเอกสารฉบับเต็ม

หากตัวเลือกของคุณอยู่ระหว่างการไม่จดบันทึกอะไรเลยและเพียงแค่เขียนโน้ตที่ไม่เป็นทางการบนแผ่นจดบันทึกจากนั้นก็แค่เขียนโน้ตที่ไม่เป็นรูปแบบ

คุณพูดว่า: "บางคนมีปัญหานี้ซึ่งพวกเขาไม่สามารถคิดได้หากไม่มีคำพูดและการเขียนความคิดและการตัดสินใจของพวกเขาเป็นวิธีที่มีประสิทธิภาพที่สุดในการดำเนินการ"

หากเขียนความคิดและการตัดสินใจของคุณเป็นวิธีที่มีประสิทธิภาพที่สุดในการดำเนินการทำไมมันไม่ปกติและเป็นที่ยอมรับในการดำเนินการในวิธีที่มีประสิทธิภาพมากที่สุด? คุณทำสิ่งที่ดีที่สุดสำหรับคุณ อาจไม่ใช่สิ่งที่ดีที่สุดสำหรับคนอื่น ในกรณีนี้คุณจะไม่ปล่อยให้คนอื่นบอกคุณว่าอะไรดีที่สุดสำหรับคุณและคุณจะไม่บอกพวกเขาว่าอะไรดีที่สุดสำหรับพวกเขา ทุกคนทำสิ่งที่ดีที่สุดสำหรับพวกเขา

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

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

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

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