mã thông báo trong studio trực quan: HACK, TODO ... bất kỳ thẻ nào khác?

Question

mã thông báo nào bạn thấy hữu ích trong phòng thu trực quan? (Visual Studio 2010 → môi trường → danh sách công việc → tokens)

hiện tôi chỉ có:

• HACK-thấp
• ĐÁNH GIÁ - cao
• TODO - bình thường
• WTF - cao

(chỉ những - xóa một số những người mặc định)

bạn đang sử dụng bất kỳ những người khác?

bạn có bao gồm bất kỳ điều quan trọng nào khác với mã thông báo nhận xét không?

bất kỳ phương pháp hay nhất nào? thnx

Answer 1

Dưới đây là những cái tôi sử dụng:

• TODO: các chức năng vẫn chưa được thực hiện
• FIXME: mã nên được sửa đổi/refactored để đạt được một số mục tiêu (bảo trì cao hơn, hiệu suất tốt hơn , vv)
• BUG: mã có lỗi đã biết

Answer 2

Một tích hợp khác là LƯU Ý.

Answer 3

Vim tự động làm nổi bật XXX, đây sẽ là mã thông báo lựa chọn của tôi để bạn dễ dàng nhập.

Sun's (old) Java coding conventions có điều này để nói:

Sử dụng XXX trong một chú thích để cờ cái gì đó là không có thật nhưng hoạt động. Sử dụng FIXME để gắn cờ cái gì đó không có thật và bị hỏng.

Answer 4

Tôi đã kết hợp hầu hết các mã thông báo ở trên.

RED: code that simply does not work/compile 
// Error - This code is throwing a specific reproducible error. 
// Broken - This code is broken and will not run. 
// WTF - WHAT THE FRIG. 

ORANGE: code that works but is not right 
// Hack - This code has intentionally been hacked in order to work. Should not go into production. 
// FixMe - This code works but could be better. Needs better abstraction, maintainability, performance, etc. 
// Bug - This code works and was expected to be right but a bug has been found. (usually flagged post production) 
// Review - This code is probably right but should be reviewed for piece of mind. 
// Smells - Same as FixMe 

BLUE: code that works but either needs more features or more explaining 
// Todo - Functionality is not yet implemented 
// Note - Better explain what's going on. This is gives a higher profile to standard comments, and allows notes to be found in the to-do pane. 

Answer 5

Tôi thích Token BỎ, chỉ ra rằng nó chỉ trong để thử nghiệm, và không nên được bao gồm trong bản phát hành chính thức