Ghét con trăn

Nhận xét là một phần không thể thiếu của bất kỳ chương trình nào. Chúng có thể ở dạng chuỗi tài liệu cấp mô-đun hoặc dưới dạng các giải thích nội tuyến để làm rõ các hàm phức tạp

Trước khi đi chi tiết vào các loại bình luận khác nhau trong Python, cùng nhìn rõ hơn lý do vì sao bình luận trong lập trình lại quan trọng đến thế. Giờ thì cùng nhìn vào hai vấn đề khi lập trình viên không viết bình luận trong mã của họ

Love 1. When read your own code

Khách hàng A muốn thay đổi một số yếu tố trên trang web của họ trong phút chờ đợi. Dưới áp lực thời gian, bạn quyết định sẽ chỉ viết lại mã miễn phí sao cho chúng tôi có thể hoạt động và trả lời yêu cầu của khách hàng. Tất cả các thành phần mang tính bổ sung như tài liệu, nhận xét,. will be add to after that

Sau khi đã hoàn thành trang web theo yêu cầu của khách hàng, bạn chuẩn bị quay lại để cập nhật danh sách bình luận. Không thể, bạn lại được yêu cầu phải bắt đầu một dự án mới, và làm như vậy, bạn hoàn toàn quên mất việc phải quay lại viết bình luận cho dự án của khách hàng A

Sáu tháng sau, khách hàng yêu cầu bạn phải cập nhật lại trang web của họ với một số yêu cầu mới. Nhiệm vụ của bạn là người bảo trì trang web bởi chính bạn là người đã xây dựng trang web đó ngay từ đầu. Bạn mở lại trình soạn thảo văn bản và chính vào lúc này bạn sẽ nhận ra mình không nhớ rằng mình đã viết những gì. Do đó, bạn phải hoàn thành hàng giờ để phân tích lại mã cũ. Nhưng vấn đề đặt ra là bạn đã không đặt tên biến thích hợp và cũng không thiết lập các chức năng theo một bộ điều khiển luồng thích hợp. Và tệ hơn cả, bạn không có bất kỳ bình luận nào để chỉ cho bạn biết mình đã viết những gì

Nhìn chung, các nhà phát triển thường quên mất những dòng code mà chính mình đã viết, đặc biệt nếu chúng được viết từ lâu. Làm như vậy, họ có thể phải ngồi hàng giờ để phân tích lại những gì mình đã viết. Làm như vậy, sử dụng thêm các bình luận mặc dù có thời gian nhưng vẫn là cách tốt nhất để hạn chế các vấn đề liên quan đến bảo trì hoặc cập nhật dự án

Trường hợp 2. Khi những người khác đọc mã của bạn

Hãy tưởng tượng bạn là nhà phát triển duy nhất trong dự án Django small. Bạn đã hiểu rõ các đoạn mã của mình, vậy bạn cảm thấy việc sử dụng các bình luận là thừa. Nhưng khi dự án của bạn được mở rộng và trở nên đồ sộ hơn, nhiều nhà phát triển sẽ bổ sung thêm vào dự án để duy trì nó. Giờ đây họ phải đọc và hiểu những dòng mã mà bạn đã viết. Nhưng với một dự án với các tên biến rắc rối và cú pháp ngắn, họ có thể mất rất nhiều thời gian để bắt kịp và giúp bạn duy trì nó

Việc bổ sung các bình luận trong suốt thời gian thiết lập chương trình sẽ giúp bạn hạn chế các vấn đề phát sinh ngoài ý muốn. Khi bạn cần bàn giao dự án của mình cho các nhà phát triển khác, họ sẽ hiểu được cách thức hoạt động của họ nhanh hơn.

>>> Tham khảo khóa học lập trình Python

Kiến thức cơ bản về comment trong Python

Cách viết bình luận trong Python

Để viết bình luận trong Python, bạn chỉ cần đặt dấu thăng # ngay trước bình luận mà bạn muốn.  

# Đây là một bình luận

Trong Python, các mã bắt đầu bằng dấu thăng sẽ bị loại bỏ khi biên dịch, do đó bạn có thể chèn nhận xét vào bất kỳ đâu, ngay cả trong một dòng mã khác

print("Điều này sẽ chạy. ")  # Điều này sẽ không chạy

Nhận xét nhiều dòng trong Python

Không giống như C, Java và Go, Python không có cách nào để viết nhận xét nhiều dòng, ví dụ

# Vì vậy, bạn không thể

chỉ cần làm điều này

trong trăn

Trong ví dụ này, phần sau dấu thăng ở dòng đầu tiên sẽ bị chương trình bỏ qua, hai dòng còn lại sẽ gây ra lỗi cú pháp cho chương trình. Mặc dù Python không có chức năng nhận xét nhiều dòng, nhưng có hai cách để bạn có thể thêm nhiều dòng nhận xét

Cách đầu tiên là nhấn phím  return sau mỗi dòng, một dấu thắng mới sẽ xuất hiện và bạn có thể thêm nhận xét từ đó. Ví dụ

def multiline_example().

     # Đây là một ví dụ khá hay

# về cách bạn có thể lan truyền bình luận

# trên nhiều dòng trong Python

Cách khác để viết nhiều dòng nhận xét là sử dụng bộ ba dấu ngoặc kép như sau

"""

Nếu tôi thực sự ghét nhấn `enter` và

gõ tất cả những dấu thăng đó, tôi có thể

chỉ cần làm điều này thay vào đó

"""

Về mặt kỹ thuật, đây không phải là một nhận xét, nó là một chuỗi không được gán cho bất kỳ biến nào, vì vậy chương trình sẽ không gọi hoặc tham khảo nó. Làm như vậy, nó có thể hoạt động như một bình luận

>>>Xem thêm. Flask là gì?

Các phím tắt Comment trong Python

Việc nhập dấu thăng để thêm nhận xét trong Python có thể là một thao tác dư thừa và thay đổi. Làm như vậy, bạn có thể sử dụng một số thủ thuật để tăng tốc khi bổ sung các bình luận.  

Một trong những điều đầu tiên bạn có thể làm là sử dụng nhiều con trỏ. Giữ phím Ctrl hoặc Cmd khi nhấp chuột trái và bạn sẽ thấy các dòng nhấp nháy trên màn hình chính của mình như sau

 

Ghét con trăn

Phím tắt để sử dụng nhận xét trong Python

Cách này sẽ vô cùng hữu ích khi bạn cần bình luận cùng một ý kiến ​​ở nhiều vị trí khác nhau

Nếu nhận xét rằng bạn thêm vào chương trình quá dài, trình soạn thảo văn bản sẽ cung cấp cho bạn tùy chọn để thu gọn chúng bằng cách sử dụng mũi tên xuống nhỏ ở phía bên trái

Chỉ cần nhấp vào mũi tên để ẩn các nhận xét. Việc làm này sẽ làm cho mã của bạn trông ngắn gọn hơn với các nhận xét được viết trải nghiệm dài trên nhiều dòng và chiến phần thời gian chạy chương trình lớn hơn

Ghét con trăn

Cách ẩn bình luận trong Python

Kết hợp các mẹo trên, mã của bạn sẽ trở nên nhanh chóng, dễ dàng và hiệu quả hơn

Kết luận

Nhận xét là một công cụ quan trọng giúp bạn viết mã rõ ràng và rút gọn hơn trong Python. Biết cách viết bình luận trong Python có thể giúp cuộc sống của tất cả các nhà phát triển, bao gồm cả chính bạn trở nên dễ dàng hơn. Nhận xét có thể giúp các nhà phát triển khác bắt kịp những gì chương trình của bạn đang thực hiện và giúp bạn làm quen lại với các mã của riêng bạn