Tại sao mọi người viết bình luận để làm bằng chữ in hoa? [đóng cửa]

9

Tôi cũng đang làm như vậy. Khi có một cái gì đó "phải làm" trong mã của tôi, tôi viết //TODO .... Nhưng tôi tò mò muốn biết khi nào điều này bắt đầu và liệu có lý do để viết "to-dos" trong tất cả các chữ in hoa không?

comments 
— Mohsen
nguồn
20
Bởi vì chúng tôi thực sự Ý NGH ITA (chúng tôi thực sự không bao giờ thực hiện được)
— Anthony Pegram
3
vì vậy các biên tập viên có thể đánh dấu chúng và cho phép bạn tìm kiếm thông qua chúng (ví dụ như danh sách nhiệm vụ của nhật thực)
— ratchet freak
6
Vì bạn thực sự không thể làm cho văn bản in đậm bên trong mã, bạn cần một số cách để làm cho những điều quan trọng trở nên nổi bật. Do đó ...
— Karlson
4
Tại sao nó quan trọng?
— Rook
3
Tôi viết//todo:...
— BЈовић

Câu trả lời:

23

Ngoài ra, thật tuyệt khi có một cách dễ dàng tìm kiếm các phần mã mà bạn đã xem và muốn quay lại. Bạn có thể thực hiện tìm kiếm phân biệt chữ hoa chữ thường cho "TODO" để tìm ngay những gì bạn đã bỏ qua trước đó.

"việc cần làm" (chữ thường) có thể có khả năng là một phần của từ / hàm / biến lớn hơn, nhưng "TODO" (chữ hoa) có thể sẽ không xảy ra.

— Butkus tinh tế
nguồn
4
Nó cũng cho phép các biên tập viên làm nổi bật điều này. gedit làm điều đó, ví dụ, và nó chỉ làm điều đó cho tất cả các chữ hoa TODO. Dù lý do là gì đi nữa, nó đủ khuyến khích tôi viết nó bằng chữ in hoa.
4
@delnan: Đó là một tautology. Nó đã được thực hiện để dính ra, vì vậy mọi người đã sử dụng nó, vì vậy ai đó đã thêm cú pháp tô sáng trong vim để nổi bật hơn, vì vậy mọi người sử dụng nó để nổi bật. Mọi người không sử dụng nó bởi vì trình soạn thảo làm cho nó nổi bật, họ sử dụng nó bởi vì nó là phổ biến để làm như vậy và do đó trình soạn thảo làm cho nó nổi bật. Bạn có thể làm bất cứ điều gì nổi bật trong vim chỉ cần thay đổi cú pháp tô sáng một cách thích hợp, thật dễ dàng để làm todonổi bật nhưng có một điểm nhỏ trong đó là quy ước là sử dụng TODO.
— Martin York
1
@LokiAstari: Như tôi đã nói, tôi cho một lỗi chính tả trong thủ đô vì nhiều biên tập viên làm nổi bật điều đó theo mặc định. Nhưng có lẽ tôi là một ngoại lệ: Khá trẻ (vì vậy tôi không thể thực hiện được trước khi các biên tập viên hỗ trợ nó) và (đáng buồn thay) quá nhiều sự lười biếng và lười biếng để điều chỉnh đánh dấu cú pháp bằng tay.
Cũng tốt cho anh chàng nghèo cần dọn dẹp sau bạn và cho bất cứ ai cần xem qua mã của bạn trước khi hoàn tất. Họ có thể thấy trong nháy mắt những gì chưa được thực hiện vì quy ước này.
— sq33G
2
Tôi đã gặp TODO trường hợp hỗn hợp trong một tên biến như filesToDownload. Tất nhiên, tìm kiếm "toàn bộ từ" chỉ khắc phục vấn đề đó.
— dan04
8

Tôi tò mò muốn biết khi nào điều này bắt đầu và nếu có một lý do để viết tất cả vốn?

Ý tưởng với các bình luận như TODO và FIXME là làm cho chúng nổi bật. Nói chung, bạn không muốn gửi mã có các điểm đánh dấu như vậy trong mã - họ đánh dấu những việc cần thực hiện trước khi dự án có thể được coi là hoàn thành. Sử dụng TẤT CẢ CAPS giúp chúng dễ dàng phát hiện hơn một chút, miễn là bạn không sử dụng TẤT CẢ CAPS cho nhiều thứ khác trong mã của mình.

— Caleb
nguồn
5

Cả Eclipse và Visual Studio đều có các tính năng Danh sách nhiệm vụ tự động cung cấp cho bạn danh sách các dòng nhận xét có TODO trong đó.

— Ôi Jones
nguồn
Visual Studio bắt đầu thực hiện // TODO: nhận xét khi lần đầu tiên thêm trình tạo mã cho công cụ soạn thảo MFC. Đó là phiên bản 2.0, iirc.
— mjfgates
ít nhất là đối với Visual studio, tìm kiếm này không phân biệt chữ hoa chữ thường - nó cũng sẽ kéo // todo foo vào danh sách tác vụ
— jk.
4

Tôi chỉ nổi bật và dễ dàng để bắt ... không có gì phức tạp!

— nhà gỗ
nguồn
1
điều đó và dễ dàng tìm thấy thông qua grep hoặc tương tự
— Zachary K
@ZacharyK: Chính xác!
— Động
1

Nó gọi sự chú ý đến thực tế là có tồn tại một việc cần làm.

Điều quan trọng là rõ ràng tất cả thời gian mà ai đó cần phải quay lại mã. Các chi tiết chỉ cần được biết bởi người quay lại để giải quyết bất cứ vấn đề gì.

— yfeldblum
nguồn
1

Nếu bạn là người dùng vi sử dụng:

/LÀM

Nó sẽ đưa bạn đến đó rất nhanh.

— ncmathsadist
nguồn
Biên tập viên khác có tính năng tìm kiếm và bạn có thể cũng giống như dễ dàng tìm kiếm todo .
— Karlson
Ngoại trừ 'việc cần làm' có thể xuất hiện trong một tên khác như tên biến hoặc văn bản nhận xét khác ...
— Sevenseacat
1
vi là trường hợp nhạy cảm. Vì mũ được sử dụng một cách tiết kiệm trong hầu hết các ngôn ngữ hiện đại (trong những thứ như hằng số được đặt tên), nên việc tìm kiếm có xác suất thành công cao.
— ncmathsadist
1

Một số trình soạn thảo chỉ làm nổi bật các mục TODO chữ hoa, vì vậy sẽ an toàn hơn khi luôn sử dụng chữ hoa.

— Tim Abell
nguồn
0

Trực quan TẤT CẢ CAPS nổi bật, nhưng không dễ đọc. Khi đọc mã họ quét như một khối có kích thước cụ thể. Nó không thực sự quan trọng những gì các chữ cái là. Họ chỉ nổi bật và có thể được nhìn thấy rất nhanh. Khi bạn đã làm việc với các thẻ trong một thời gian, bộ não của bạn sẽ nhận ra từ theo hình dạng.

Từ quan điểm của công cụ (IDE / Editor), tìm kiếm phân biệt chữ hoa chữ thường sẽ có tỷ lệ dương tính giả rất thấp trên tất cả các phiên bản mũ. Trong một số kiểu mã hóa, có một rủi ro nhỏ là hằng số sẽ được khớp. Trường hợp nhạy cảm toàn bộ tìm kiếm từ làm cho dương tính giả thậm chí ít có khả năng.

Khi công cụ có được nó trên màn hình, định dạng rõ ràng nhìn vào ĐÂY. Khi bạn tập trung vào vị trí, phần dễ đọc sẽ là phần nhận xét liên quan.

— BillThor
nguồn
Khi sử dụng trang web của chúng tôi, bạn xác nhận rằng bạn đã đọc và hiểu Chính sách cookie và Chính sách bảo mật của chúng tôi.
Licensed under cc by-sa 3.0 with attribution required.