Tôi có nên viết bình luận không?

Suy nghĩ về mã bình luận và bình luận đúng cách

Chúng tôi thường nói rằng nhận xét là rất quan trọng. Nhận xét là một phần lớn và quan trọng của lập trình. Là người mới bắt đầu, thật khó để đánh giá và xác định bạn nên thêm bao nhiêu nhận xét, và viết gì trong nhận xét!

Đó là một trong những điều không cố định bằng đá, mọi người dường như có quan điểm khác nhau và trái ngược nhau, và vì vậy điều này khiến bạn rơi vào tình trạng lấp lửng đầy bất an.

Đây là dòng suy nghĩ của tôi:bạn nên viết bình luận, càng ít càng tốt, để giải thích quyết định của bạn.

Hãy mổ xẻ điều này.

Mã của bạn phải tự giải thích, càng nhiều càng tốt.

Các ngôn ngữ cấp cao như JavaScript hoặc Python rất dễ đọc. Bạn gần như có thể đọc to mã và nghĩ rằng đó là tiếng Anh đơn giản, nếu bạn đặt tên các biến và phương thức của mình một cách chính xác.

Một số thứ sẽ đòi hỏi bạn phải suy nghĩ nhiều hơn, nhưng ngay cả khi mã phức tạp một chút, miễn là một lập trình viên có thể đọc nó và xác định 100% mã hoạt động, nó sẽ không cần nhận xét.

Bạn cần nhận xét khi bạn phải giải thíchtại saocủa một lệnh hoặc khối cụ thể. Không phải, điều đó sẽ được suy ra từ mã. Chúng tôi gọi nó là mức cao vì một lý do: đó là mã mà chúng tôi có thể nghĩ đến. Nó không phải là ngôn ngữ máy hoặc hợp ngữ, rất khó đọc và hiểu.

Một số khối mã của bạn sẽ cần nhận xét để giải thích những khối khác, hoặcngay cả bản thân bạn,tại saobạn đang làm một việc cụ thể. Tất nhiên không phải lúc nào cũng vậy, không phải lúc nào cũng rõ ràng.

Thậm chí sau 6 tháng, nếu bạn làm việc trên một phần riêng biệt của cơ sở mã và sau đó quay lại dòng mã đó, rất có thể bạn sẽ không nhớ mọi thứ đang bị đe dọa khi bạn chỉnh sửa nó. Bạn có thể nhớ lại 90% lý do bạn thêm điều gì đó, nhưng có điều gì đó khác mà bạn không thể tìm ra .. một nhận xét sẽ rất tốt cho điều đó.

Mã không chỉ là hướng dẫn và bình luận. Rất nhiều lần bạn có thể thấy lý do tại sao một dòng mã được thêm vào nhờ kiểm soát nguồn (Git). Bạn nhìn vào dòng này trong ứng dụng Git của mình và lịch sử của dòng đó sẽ cho bạn biết lý do tại sao bạn hoặc đồng nghiệp của bạn đã chỉnh sửa dòng đó 10 tháng trước. Nếu thông báo cam kết Git hữu ích và chi tiết, không phải là "Sửa lỗi". Đó cũng là một tài liệu tốt, đặc biệt tốt trong các dự án Nguồn mở có thể có nhiều người chạm vào cơ sở mã.

Nếu bạn đang tham gia một cuộc phỏng vấn việc làm và bạn tự hỏi mình "tôi có nên thêm nhận xét vào bài tập của mình không?" câu trả lời luôn làĐúng.

Rất có thể họ sẽ đánh giá bạn về nhận xét cũng như về mã của bạn. Và những gì bạn viết trong các bình luận, quá.

Tôi chắc chắn sẽ làm điều đó. Cho dù bạn có thể là một trình hướng dẫn mã đến đâu, có thể công ty cần sa thải bạn trong 3 tháng và người tiếp theo đến thay thế bạn sẽ cần phải hiểu mã của bạn, vì đó là tài sản của công ty. Họ thực sự không đủ khả năng để thuê một người không sẵn lòng hoặc không có khả năng đồng cảm với những người khác đang cố gắng đọc mã nguồn.