Hướng dẫn __doc__ comment python - __doc__ comment python

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 module  hoặc dưới dạng các các giải thích nội tuyến để làm rõ các hàm phức tạp.

Nội dung chính

• Tại sao comments trong Python lại quan trọng đến vậy?
• Tình huống 1: Khi đọc mã của riêng bạn
• Trường hợp 2: Khi những người khác đọc code của bạn
• Kiến thức cơ bản về comment trong Python
• Cách viết bình luận trong Python
• Nhận xét nhiều dòng trong Python
• Các phím tắt Comment trong Python

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

Tình huống 1: Khi đọc mã của riêng bạn

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

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

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

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

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

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

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

Nhận xét nhiều dòng trong Pythonlập trình Python

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

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

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

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

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ót. Dưới sức ép thời gian, bạn quyết định sẽ chỉ viết lại code miễn sao cho chúng thể hoạt động và đáp ứng được yêu cầu của khách hàng. Tất cả những thành phần mang tính bổ sung như documentation, comments,... sẽ được thêm vào sau đó.

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

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

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

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ót. Dưới sức ép thời gian, bạn quyết định sẽ chỉ viết lại code miễn sao cho chúng thể hoạt động và đáp ứng được yêu cầu của khách hàng. Tất cả những thành phần mang tính bổ sung như documentation, comments,... sẽ được thêm vào sau đó.

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ập các danh sách comment. Không may, bạn lại được yêu cầu phải bắt đầu một dự án mới, và do đó, bạn hoàn toàn quên mất việc phải quay lại viết comment cho dự án của khách hàng A.

Sáu tháng sau, khách hàng A yêu cầu bạn phải cập nhập 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 đó ngay từ đầu. Bạn mở lại text editor 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 vậy, bạn phải tốn hàng giờ để phân tích lại code 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 hàm theo một luồng điều khiển thích hợp. Và tệ hơn cả, bạn không có bất kỳ một comments 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. Do 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. Do vậy, việc thêm các comment dù có tốn 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.

defmultiline_example(): multiline_example():

Hãy tưởng tượng bạn là nhà phát triển duy nhất trong một dự án Django nhỏ. Bạn hiểu rõ các đoạn mã của mình, do vậy bạn cảm thấy việc sử dụng các comments là thừa thãi. 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ẽ được 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ó.  # This is a pretty good example

Việc thêm các comment trong suốt thời gian lập trình sẽ giúp bạn hạn chế các tình huống 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 hoạt động của chúng nhanh chóng hơn.

>>> Tham khảo khóa học lập trình 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. 

# This is a comment

Trong Python, các code bắt đầu bằng dấu thăng sẽ được bỏ qua khi compile, do vậy bạn có thể chèn comment vào bất kỳ đâu, ngay cả trong một dòng code khác.

print("This will run.")  # This won't run

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

# This is a comment

Trong Python, các code bắt đầu bằng dấu thăng sẽ được bỏ qua khi compile, do vậy bạn có thể chèn comment vào bất kỳ đâu, ngay cả trong một dòng code khác.

print("This will run.")  # This won't runFlask là gì? Giới thiệu về Flask của Python

Việc gõ dấu thăng để thêm comment trong Python có thể là một thao tác dư thừa và nhàm chán. Do vậy, bạn có thể sử dụng một số thủ thuật để tăng tốc khi bổ sung các comment. 

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:

Phím tắt để sử dụng comment trong Python

Cách này sẽ vô cùng hữu dụng khi bạn cần comment cùng một ý ở nhiều vị trí khác nhau.

Nếu nhận xét mà 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 này sẽ khiến code 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 dài trên nhiều dòng và chiến phần lớn thời gian chạy của chương trình.

Cách ẩn comment trong Python

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

Kết luận:

Comment là một công cụ quan trọng để giúp bạn viết mã rõ ràng và ngắn gọn hơn trong Python. Biết cách viết comment 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. Comment 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 code của riêng bạn.

>>> Xem thêm các tin tức hữu ích khác về lập trình tại www.t3h.edu.vn www.t3h.edu.vn