Trong hướng dẫn này, chúng ta sẽ học cách tạo nhận xét bằng Python với sự trợ giúp của các ví dụ.
Video: Nhận xét bằng Python
Nhận xét là mô tả giúp người lập trình hiểu rõ hơn về mục đích và chức năng của chương trình.
Chúng hoàn toàn bị trình thông dịch Python bỏ qua.
Ưu điểm của việc sử dụng bình luận
Sử dụng chú thích trong các chương trình làm cho mã của chúng tôi dễ hiểu hơn. Nó làm cho chương trình dễ đọc hơn, giúp chúng ta nhớ tại sao một số khối mã nhất định được viết.
Ngoài ra, nhận xét cũng có thể được sử dụng để bỏ qua một số mã trong khi kiểm tra các khối mã khác. Điều này cung cấp một cách đơn giản để ngăn việc thực thi một số dòng hoặc viết mã giả nhanh chóng cho chương trình.
Nhận xét một dòng bằng Python
Trong Python, chúng tôi sử dụng biểu tượng băm #để viết nhận xét một dòng.
Ví dụ 1: Viết chú thích một dòng
# printing a string print('Hello world')
Đầu ra
Chào thế giới
Đây, nhận xét là:
# printing a string
Dòng này bị trình thông dịch Python bỏ qua.
Mọi thứ đến sau #đều bị bỏ qua. Vì vậy, chúng ta cũng có thể viết chương trình trên trong một dòng như sau:
print('Hello world') #printing a string
Đầu ra của chương trình này sẽ giống như trong Ví dụ 1 . Trình thông dịch bỏ qua tất cả văn bản sau đó #.
Nhận xét nhiều dòng bằng Python
Python không cung cấp một cách riêng biệt để viết nhận xét nhiều dòng. Tuy nhiên, có những cách khác để giải quyết vấn đề này.
Chúng ta có thể sử dụng #ở đầu mỗi dòng chú thích trên nhiều dòng.
Ví dụ 2: Sử dụng nhiều #
# it is a # multiline # comment
Ở đây, mỗi dòng được coi như một nhận xét duy nhất và tất cả chúng đều bị bỏ qua.
Chuỗi chữ viết cho nhận xét nhiều dòng
Mặc dù không có cách duy nhất để viết nhận xét nhiều dòng trong Python, chúng tôi biết rằng trình thông dịch Python bỏ qua các ký tự chuỗi không được gán cho một biến.
Vì vậy, chúng tôi thậm chí có thể viết một nhận xét đơn dòng như sau:
#this is a comment 'this is an unassigned string as a comment '
Ở đây, chúng ta có thể thấy rằng dòng thứ hai của chương trình là một chuỗi nhưng không được gán cho bất kỳ biến hoặc hàm nào. Vì vậy, trình thông dịch bỏ qua chuỗi.
Theo cách tương tự, chúng ta có thể sử dụng chuỗi nhiều dòng (dấu ngoặc kép) để viết nhận xét nhiều dòng.
Ký tự trích dẫn có thể là 'hoặc ".
Ví dụ 3: Sử dụng String Literals để viết Nhận xét nhiều dòng
''' I am a multiline comment! ''' print("Hello World")
Ở đây, chuỗi nhiều dòng không được gán cho bất kỳ biến nào, vì vậy nó bị trình thông dịch bỏ qua. Mặc dù về mặt kỹ thuật, nó không phải là một nhận xét nhiều dòng, nhưng nó có thể được sử dụng như một.
Python docstrings
Theo quy ước, dấu ngoặc kép xuất hiện ngay sau định nghĩa hàm, phương thức hoặc lớp là docstrings (chuỗi tài liệu).
Docstrings được liên kết với các đối tượng và có thể được truy cập bằng cách sử dụng __doc__thuộc tính.
Để tìm hiểu thêm, hãy truy cập Python docstrings.
Làm thế nào để viết bình luận tốt hơn?
- Sử dụng nhận xét để mô tả chức năng hoạt động chứ không phải chi tiết cụ thể về cách chức năng thực hiện.
- Cố gắng loại bỏ càng nhiều bình luận thừa càng tốt. Hãy thử viết mã có thể tự giải thích, sử dụng chức năng / lựa chọn tên biến tốt hơn.
- Cố gắng đưa ra những nhận xét ngắn gọn và súc tích nhất có thể.
