Tôi có câu hỏi liên quan đến lập trình và ngôn ngữ tiếng Anh cả: Cho dù sử dụng người thứ ba hay bắt buộc khi nhận xét một dòng mã. Giả sử sau dòng mã trong một ngôn ngữ bắt buộc cần được nhận xét:Kiểu nhận xét: Người yêu cầu hoặc người thứ ba
object.doSomething();
Tiếp cận của tôi nhận xét dòng này sẽ được đưa nhận xét đằng sau nó sử dụng người thứ ba như thế này sẽ là một câu tiếng Anh thông thường có chứa các dòng như subject:
object.doSomething(); // does (referencing to the line of code) some action
Nhưng vì chúng ta đang ở trong một ngôn ngữ bắt buộc và do đó thực sự "chỉ huy" các máy tính, người ta thậm chí có thể nghĩ đến việc đưa những nhận xét trước khi mã và sử dụng bắt buộc:
//Do some action:
object.doSomething();
Điều này thậm chí hữu ích khi cần phải nhận xét nhiều dòng liên quan đến nhau.
Cá nhân tôi thích phong cách đầu tiên nhưng tôi thường cảm thấy không chắc chắn về kiểu sử dụng. Nó sẽ là tuyệt vời nếu một số có thể viết kinh nghiệm cá nhân của họ xuống đây.
Địa điểm không phù hợp để yêu cầu. Nhận xét không nên là một sự lặp lại mã. Có toàn bộ sách dành riêng cho khả năng đọc mã. –
Nếu bạn cần phải bình luận về ý định của mã ở cấp độ dòng và nó không phải là mã máy, bạn có nhiều vấn đề hơn so với động từ căng thẳng! Kinh nghiệm cá nhân của tôi là những người thiết lập các thực hành bình luận điên rồ, không bao giờ duy trì nhận xét .... –
@BasileStarynkevitch: Tôi đã lưu các ví dụ đơn giản để cải thiện khả năng trừu tượng và dễ đọc của câu hỏi này. Tôi không cho rằng những lời bình luận để lặp lại mã như họ làm ở đây nhưng phải đi vào chi tiết. Đâu là nơi thích hợp để hỏi ?; tôi không thấy diễn đàn tiếng Anh từ StackExchange phù hợp bởi vì trong quan điểm của tôi câu hỏi này là rất nhiều liên quan đến mã hóa. – Paranaix