ฉันทำเช่นเดียวกัน เมื่อมีสิ่งที่ "ต้องทำ" //TODO ...
ในรหัสของฉันฉันเขียน แต่ฉันอยากรู้ว่าจะเริ่มเมื่อไหร่และถ้ามีเหตุผลในการเขียน "to-dos" ในตัวพิมพ์ใหญ่ทั้งหมด?
//todo:...
ฉันทำเช่นเดียวกัน เมื่อมีสิ่งที่ "ต้องทำ" //TODO ...
ในรหัสของฉันฉันเขียน แต่ฉันอยากรู้ว่าจะเริ่มเมื่อไหร่และถ้ามีเหตุผลในการเขียน "to-dos" ในตัวพิมพ์ใหญ่ทั้งหมด?
//todo:...
คำตอบ:
นอกจากนี้ยังเป็นเรื่องดีที่มีวิธีการค้นหาส่วนรหัสที่คุณคัดสรรและต้องการกลับไป คุณสามารถค้นหาด้วยตัวพิมพ์เล็กและตัวพิมพ์ใหญ่สำหรับ "สิ่งที่ต้องทำ" เพื่อค้นหาสิ่งที่คุณข้ามไปทันที
"todo" (ตัวพิมพ์เล็ก) อาจเป็นส่วนหนึ่งของคำ / ฟังก์ชัน / ตัวแปรที่มีขนาดใหญ่กว่า แต่ "TODO" (ตัวพิมพ์ใหญ่) อาจไม่เป็นเช่นนั้น
TODO
ใหญ่ทั้งหมดเท่านั้น ไม่ว่าด้วยเหตุผลอะไรมันก็เป็นสิ่งจูงใจที่เพียงพอสำหรับผมที่จะเขียนมันขึ้นมา
todo
โดดเด่น แต่มีจุดเล็ก ๆ น้อย ๆ ในการประชุมที่จะใช้สิ่งที่ต้องทำ
filesToDownload
ฉันได้พบกรณีผสมสิ่งที่ต้องทำภายในชื่อตัวแปรเช่น แน่นอนการค้นหา "ทั้งคำเท่านั้น" แก้ไขปัญหานั้นได้
ฉันอยากรู้ว่าสิ่งนี้เริ่มต้นเมื่อไหร่และหากมีเหตุผลในการเขียนถึงทุนทั้งหมด?
ความคิดที่มีความคิดเห็นเช่นสิ่งที่ต้องทำและ FIXME คือการทำให้พวกเขาโดดเด่น โดยทั่วไปคุณไม่ต้องการจัดส่งรหัสที่มีเครื่องหมายดังกล่าวในรหัส - สิ่งเหล่านี้ทำเครื่องหมายสิ่งที่ต้องทำก่อนที่โครงการจะพิจารณาเสร็จสมบูรณ์ การใช้ CAPS ทั้งหมดช่วยให้มองเห็นได้ง่ายขึ้นเล็กน้อยหากคุณไม่ได้ใช้ CAPS ทั้งหมดสำหรับสิ่งอื่น ๆ มากมายในรหัสของคุณ
ทั้ง Eclipse และ Visual Studio มีคุณสมบัติรายการงานที่ให้รายการรายการความคิดเห็นที่มีสิ่งที่ต้องทำโดยอัตโนมัติ
มันเรียกร้องความสนใจไปที่ความเป็นจริงที่ว่ามีอยู่สิ่งที่ต้องทำ
เป็นสิ่งสำคัญที่จะต้องชัดเจนตลอดเวลาที่มีคนต้องการกลับมาใช้รหัส รายละเอียดจะต้องเป็นที่รู้จักโดยคนที่จะกลับไปที่อยู่สิ่งที่เป็นปัญหา
หากคุณเป็นผู้ใช้ vi:
/ทำ
มันจะพาคุณไปที่นั่นอย่างรวดเร็ว
บรรณาธิการบางคนเน้นเฉพาะรายการสิ่งที่ต้องทำตัวพิมพ์ใหญ่ดังนั้นจึงปลอดภัยกว่าที่จะใช้ตัวพิมพ์ใหญ่ทุกครั้ง
สายตาแคปทั้งหมดโดดเด่น แต่ไม่ชัดเจนมาก เมื่ออ่านรหัสพวกเขาสแกนเป็นบล็อกขนาดเฉพาะ ไม่สำคัญว่าจดหมายจะเป็นอะไร พวกเขาโดดเด่นและสามารถมองเห็นได้อย่างรวดเร็ว เมื่อคุณทำงานกับแท็กมาระยะหนึ่งสมองของคุณจะรับรู้คำต่าง ๆ
จากมุมมองเครื่องมือ (IDE / Editor) การค้นหาตัวพิมพ์เล็กและตัวพิมพ์ใหญ่จะมีอัตราการบวกที่ผิดพลาดต่ำมากในตัวพิมพ์ใหญ่ทั้งหมด ในรูปแบบการเข้ารหัสบางอย่างมีความเสี่ยงเล็กน้อยที่ค่าคงที่จะถูกจับคู่ การค้นหาคำทั้งตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ทำให้เกิดผลบวกที่ผิดพลาด
เมื่อเครื่องมือได้รับมันบนหน้าจอรูปแบบที่ชัดเจนบอกว่าดูที่นี่ เมื่อคุณมุ่งเน้นไปที่สถานที่ส่วนที่ชัดเจนจะเป็นความคิดเห็นที่เกี่ยวข้อง