[DOTNETVN] TUI LÀ MỘT DEV ANTI CODE COMMENT.

Hôm này trong chuyên mục CAFÉ CODER mình xin chia sẽ cách nhìn của mình về việc sử dụng comment trong code. Mình thật sự rất anti vấn đề này, các bạn xem chi tiết bên dưới nhé để hiểu vì sao mình anti nha..

TUI LÀ MỘT DEV ANTI CODE COMMENT

Trước tiên mình muốn các bạn nhìn vào đoạn code bên dưới, chậm lại tầm 10 giây để đưa ra suy nghĩ của bạn về đoạn code này trước khi đọc phần chém gió của mình bên dưới.

Anti Code Comment

Tui là tui rất ghét khi thấy code có quá nhiều comment, nó chiếm không gian editor của bạn và có vẻ như nó chứng tỏ rằng chúng ta kém về khả năng diễn đạt thứ mà chúng ta đang làm, kiểu như sợ người khác không hiểu ấy.

Một vấn đề khá nghiêm trọng khi bạn đã lỡ comment quá nhiều vào code là khi chúng ta chỉnh sửa code thì tui cá luôn là đa số các chú dev ít khi quan tâm tới việc chỉnh sửa lại tất cả comment cho phù hợp với code mới và đó sẽ là một thảm họa một khi có ai đó đọc vào code của bạn.

Vậy câu hỏi đặt ra là code sao cho dễ hiểu?. Theo ngu kiến của tui thì là vầy (ai chém mặc xác nha):

1. Biết rõ code của bạn sẽ làm gì trước khi bắt tay vào viết nó.

2. Tránh viết code thừa, chỉ để lại những dòng code mà mình cần.
=> đa số dev hay có kiểu comment lại code cũ xong viết code mới đè lên. Quên nó đi, mạnh mẽ lên delete nó, nếu muốn backup thì copy vs paste nó vào file khác đặt tên abc_back_20190725.cs chẳng hạn.

3. Comment trên đầu hàm theo format: hàm dùng làm gì, tham số đầu vào, kết quả trả về là gì.

4. Đừng dùng dao mổ trâu đi giết gà, đại loại là 1 đoạn code đơn giản thì hãy để nó đơn giản đừng cố apply design pattern hay giải thuật gì gì đó chỉ để chứng tỏ tui đây là siêu coder.
=> đây chính hắn là kẻ thù của dân đi maintain lại dự án của người trước đã bỏ của chạy lấy người 😟😟😟

5. Cố gắng đặt tên biến và function gần với tính năng mà bạn đang làm (cái này có vẻ khó nhỉ nhưng làm nhiều quen tay thôi).

6. Hạn chế gõ comment trong thân hàm, trừ khi nó là một siêu giải thuật mà người ta đọc không hiểu gì hết thì hãy comment).

Thông tin bài viết