ทำไมทุกคนเขียนความคิดเห็นที่ต้องทำในตัวอักษรพิมพ์ใหญ่? [ปิด]


9

ฉันทำเช่นเดียวกัน เมื่อมีสิ่งที่ "ต้องทำ" //TODO ...ในรหัสของฉันฉันเขียน แต่ฉันอยากรู้ว่าจะเริ่มเมื่อไหร่และถ้ามีเหตุผลในการเขียน "to-dos" ในตัวพิมพ์ใหญ่ทั้งหมด?


20
เพราะเราหมายถึงมันจริงๆ (เราไม่เคยได้รับจริง ๆ )
แอนโทนี่ Pegram

3
ดังนั้นบรรณาธิการสามารถทำเครื่องหมายพวกเขาและช่วยให้คุณสามารถค้นหาผ่านพวกเขา (รายการงานคราสของตัวอย่าง)
วงล้อประหลาด

6
เนื่องจากคุณไม่สามารถทำให้ข้อความเป็นตัวหนาในรหัสคุณจำเป็นต้องมีวิธีที่จะทำให้สิ่งสำคัญโดดเด่น ดังนั้น ...
Karlson

4
ทำไมมันถึงสำคัญ?
โกง

3
ฉันเขียน//todo:...
BЈовић

คำตอบ:


23

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

"todo" (ตัวพิมพ์เล็ก) อาจเป็นส่วนหนึ่งของคำ / ฟังก์ชัน / ตัวแปรที่มีขนาดใหญ่กว่า แต่ "TODO" (ตัวพิมพ์ใหญ่) อาจไม่เป็นเช่นนั้น


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

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

1
@ LokiAstari: ตามที่ฉันได้กล่าวไปฉันจะสะกดมันเป็นตัวพิมพ์ใหญ่เพราะตัวแก้ไขเพิ่มเติมเน้นว่าโดยค่าเริ่มต้น แต่บางทีฉันอาจจะได้รับการยกเว้น: ค่อนข้างอ่อน (ดังนั้นฉันไม่สามารถทำมันได้ก่อนที่บรรณาธิการจะสนับสนุน) และ (เศร้า) มากเกินไปที่จะทำเสียงหัวเราะและขี้เกียจก้นเพื่อปรับการเน้นไวยากรณ์ด้วยตนเอง

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

2
filesToDownloadฉันได้พบกรณีผสมสิ่งที่ต้องทำภายในชื่อตัวแปรเช่น แน่นอนการค้นหา "ทั้งคำเท่านั้น" แก้ไขปัญหานั้นได้
dan04

8

ฉันอยากรู้ว่าสิ่งนี้เริ่มต้นเมื่อไหร่และหากมีเหตุผลในการเขียนถึงทุนทั้งหมด?

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


5

ทั้ง Eclipse และ Visual Studio มีคุณสมบัติรายการงานที่ให้รายการรายการความคิดเห็นที่มีสิ่งที่ต้องทำโดยอัตโนมัติ


Visual Studio เริ่มทำ // สิ่งที่ต้องทำ: ความคิดเห็นเมื่อเพิ่มตัวสร้างรหัสสำหรับสิ่งที่สร้างต้นแบบแผ่น MFC นั่นคือเวอร์ชัน 2.0, iirc
mjfgates

อย่างน้อยสำหรับ Visual Studio การค้นหานี้ไม่คำนึงถึงตัวอักษรพิมพ์เล็ก - มันจะดึง // todo foo ลงในรายการงานด้วย
jk

4

ฉันโดดเด่นและง่ายต่อการจับ ... ไม่มีอะไรซับซ้อน!


1
นั่นและมันหาง่ายผ่าน grep หรือสิ่งที่คล้ายกัน
Zachary K

@ZacharyK: แน่นอน!
Dynamic

1

มันเรียกร้องความสนใจไปที่ความเป็นจริงที่ว่ามีอยู่สิ่งที่ต้องทำ

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


1

หากคุณเป็นผู้ใช้ vi:

/ทำ

มันจะพาคุณไปที่นั่นอย่างรวดเร็ว


บรรณาธิการอื่น ๆ ที่มีคุณลักษณะการค้นหาและคุณสามารถได้อย่างง่ายดายเพียงค้นหาสิ่งที่ต้องทำ
Karlson

ยกเว้น 'สิ่งที่ต้องทำ' อาจปรากฏในสิ่งอื่นเช่นชื่อตัวแปรหรือข้อความอื่น ๆ อีกเพียบ ...
sevenseacat

1
vi คำนึงถึงขนาดตัวพิมพ์ เนื่องจากตัวพิมพ์ใหญ่ถูกใช้อย่าง จำกัด ในภาษาสมัยใหม่ส่วนใหญ่ (ในสิ่งต่าง ๆ เช่นค่าคงที่ที่มีชื่อ) การค้นหาจึงมีโอกาสสูงที่จะประสบความสำเร็จ
ncmathsadist

1

บรรณาธิการบางคนเน้นเฉพาะรายการสิ่งที่ต้องทำตัวพิมพ์ใหญ่ดังนั้นจึงปลอดภัยกว่าที่จะใช้ตัวพิมพ์ใหญ่ทุกครั้ง


0

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

จากมุมมองเครื่องมือ (IDE / Editor) การค้นหาตัวพิมพ์เล็กและตัวพิมพ์ใหญ่จะมีอัตราการบวกที่ผิดพลาดต่ำมากในตัวพิมพ์ใหญ่ทั้งหมด ในรูปแบบการเข้ารหัสบางอย่างมีความเสี่ยงเล็กน้อยที่ค่าคงที่จะถูกจับคู่ การค้นหาคำทั้งตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ทำให้เกิดผลบวกที่ผิดพลาด

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

โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.