Đánh dấu tag trong source code

Trong quá trình lập trình, sẽ có ghi chú hoặc bình luận, giải thích mà chưa có thời gian làm (để sau), hoặc 1 ý kiến gì đó cho các lập trình viên khác, thì nhóm sẽ dùng các dấu # như là 1 tag và có thể tìm kiếm và chinh sửa, phát triển sau.

Danh sách các tags hay dùng:

  • #DEPRECATED: tức sẽ loại bỏ (không còn dùng nữa) trong thời gian tới. Nhớ thêm mốc thời gian và kể cả nếu có cần thì hiển thị cho lập trình viên (ví dụ từ protocol API trả về tham số thì thêm thông báo này). Thêm ngày giờ như #20240101 nghĩa là sau 1st Jan 2024 sẽ không còn khả dụng.

  • #FIX_ME: đây là bug mà chưa kịp fix; ghi chú cho team cùng biết.

  • #CHECK_ME: đoạn code đọc không hiểu và cần thiết cải tiến, hoặc cần thêm comment.

  • #CONFIRM: 1 lập trình viên chưa hiểu hết 100% và cần confirm từ tác giả.

Ghi chú

  • Miễn là có dấu # đằng trước là được, không cần viết Hoa thường.

  • Có thể dùng dấu _ hay dấu - tùy ý, vì cũng chỉ là 1 comment thôi. Quan trong là nhóm thỏa thuận và báo trên slides (báo cáo) để tất cả cùng biết.

Last updated