Những ưu và nhược điểm (nhưng chủ yếu là ưu) của các bình luận trong mã

0
14

        Tự viết mã tốt, nhưng đôi khi các bình luận rất quan trọng để giúp các nhà phát triển hiểu lý do tại sao bạn viết mã theo một cách nhất định.
    

        
                                                                                    
                        

 istock-984117566-2.jpg "width =" 770 "/> </span><figcaption>
<p>
                                            Hình ảnh: scyther5, Hình ảnh Getty / iStockphoto<br />
                                        </p>
</figcaption></figure>
<p> Bạn có nên thêm nhận xét vào mã của mình hay không? Câu trả lời, tất nhiên, là có. Nó cũng không. Hoặc, ít quan trọng hơn, "Trước tiên, bạn nên cố gắng làm cho mã của mình đơn giản nhất có thể để hiểu mà không cần dựa vào nhận xét như một cái nạng. Chỉ tại thời điểm mà mã <em> không thể </em> được hiểu dễ dàng hơn khi bạn nên bắt đầu hiểu để thêm ý kiến. " Jeff Atwood đã viết lại điều đó vào năm 2006, nhưng ngày nay nó có liên quan như lúc đó. Có lẽ nhiều hơn như vậy. </p>
<p> <strong> XEM: </strong> <strong> Cách xây dựng sự nghiệp của nhà phát triển thành công (PDF miễn phí) </strong> <strong> (TechRepublic) </strong> </p>
</h2>
<p> Đưa ra chủ đề và luôn luôn (và sẽ sớm) ai đó sẽ cho bạn biết lý do tại sao bạn không nên lộn xộn mã của mình với các bình luận. Một trong những phàn nàn chính về các bình luận là chúng thêm nhiễu vào tín hiệu của mã. "Mã tốt là tự ghi lại tài liệu", câu nói được đưa ra và việc thêm nhận xét đôi khi có thể phục vụ để che giấu mã xấu và không tốt hơn. Như Bennett Garner đã viết: </p>
<blockquote>
<p> Mã nhận xét quá mức thường khó hiểu hơn mã không có nhận xét. Các ghi chú nhỏ qua lại từ tất cả các nhà bảo trì khác nhau của một dự án thường có thể bị lộn xộn. Bạn dành nhiều thời gian để đọc các bình luận hơn bạn làm mã thực tế. Và thông thường, bạn có thể hiểu chương trình hoạt động như thế nào mà không có ý kiến ​​hoàn toàn. </p>
</blockquote>
<p> Điều này đủ tệ, nhưng vấn đề phức tạp khi tuổi bình luận. Như Marco Bresciani đã lập luận, "Đừng tin vào những bình luận: chúng không bao giờ được cập nhật. Chỉ có mã mới nói lên sự thật." Nhận xét <em> có thể </em> có thể hữu ích tại một số điểm, nhưng khi mã thay đổi (và đó là phổ biến), các nhận xét thường không. Điều này khiến mã bị lộn xộn với các bình luận lỗi thời có thể gây nhầm lẫn thay vì làm rõ. "Các nhà phát triển lý tưởng sẽ cập nhật nhận xét của họ khi cập nhật mã, nhưng điều này có xu hướng không xảy ra. </p>
<p> Tất nhiên, hầu hết các trình soạn thảo mã đều hỗ trợ gấp mã, ẩn các bình luận và cho phép các nhà phát triển chỉ nhìn vào mã nguồn. Nhưng điều này giả định rằng các bình luận luôn luôn xấu, điều đó không đúng. Khi nào họ có thể được bảo hành? </p>
<h2> Trường hợp cho ý kiến ​​</h2>
<p> Hãy cố gắng nhiều nhất có thể để làm cho mã của bạn "tự ghi lại tài liệu", một điều mà mã không thể làm: Giải thích <em> tại sao </em> đằng sau mã. Như Jef Raskin đã lưu ý, "[T] mã lý do cơ bản của anh ta không bao giờ có thể tự tạo tài liệu và các trình tạo tài liệu tự động không thể tạo ra những gì cần thiết là họ không thể giải thích tại sao chương trình được viết và lý do để chọn phương pháp này hay phương pháp đó. Họ không thể thảo luận về lý do một số phương pháp thay thế đã được thực hiện. " Ví dụ, bạn có thể cần phải giải thích lý do tại sao một con đường không trực quan được thực hiện, như Bill Sourour gọi, nhờ đó tiết kiệm cho các nhà phát triển trong tương lai sự bận tâm của cách tiếp cận rõ ràng hơn (nhưng sai). </p>
<p> Một lần nữa, chính cần nhấn mạnh để viết mã chất lượng cao, súc tích mà (ít nhiều) giải thích chính nó. Nếu điều này là không thể (và không phải lúc nào cũng có thể), "Hãy nghĩ về các bình luận như đóng băng trên bánh, tồn tại để cung cấp cho người đọc thông tin không thể dễ dàng thể hiện bằng chính mã", để sử dụng Brian Hannaway từ ngữ. </p>
<p> Điều quan trọng, anh ấy tiếp tục, điều quan trọng là phải giữ cho khán giả của bạn trong tâm trí. Đó là một giả định tồi khi nghĩ rằng những người đến với mã của bạn sau này sẽ có cùng trình độ chuyên môn. Do đó, ông đã gợi ý, phục vụ cho những người ít kinh nghiệm hơn: </p>
<blockquote>
<p> [Y] ou nên làm cho bình luận của bạn có thể truy cập và hữu ích cho càng nhiều độc giả càng tốt. Nếu bạn là một nhà lãnh đạo công nghệ có kinh nghiệm với kiến ​​thức tên miền mạnh mẽ, bạn không nên nhận xét về mã của mình khi cho rằng [person] phía sau bạn sẽ biết nhiều như bạn. Thay vào đó, hãy viết bình luận của bạn với các nhà phát triển ít kinh nghiệm hơn. </p>
</blockquote>
<p> Tóm lại, có những lý do tuyệt vời để giữ bình luận ở mức tối thiểu, nhưng chúng không làm giảm nhu cầu bình luận hoàn toàn. Bạn cần các nhà phát triển tiếp theo để có thể hiểu mã của mình: Điều đó bắt đầu bằng việc viết mã sạch, súc tích, nhưng kết thúc bằng bình luận vừa đủ để giúp họ hiểu <em> tại sao </em> bạn đã làm mọi thứ theo một cách nhất định. </p>
<div data-component=                                                                                 

                                                

Cũng xem