Nhận xét có thể được sử dụng để giải thích mã Python.
Nhận xét có thể được sử dụng để làm cho mã dễ đọc hơn.
Nhận xét có thể được sử dụng để ngăn chặn thực thi khi kiểm tra mã.
Tạo một bình luận
Nhận xét bắt đầu bằng
# create a variable
name = 'Eric Cartman'
# print the value
print[name]
1 và Python sẽ bỏ qua chúng:Nhận xét có thể được đặt ở cuối dòng và Python sẽ bỏ qua phần còn lại của dòng:
Một nhận xét không phải là văn bản giải thích mã, nó cũng có thể được sử dụng để ngăn chặn Python thực thi mã:
Nhận xét đa dòng
Python không thực sự có cú pháp cho các bình luận nhiều dòng.
Để thêm nhận xét đa dòng, bạn có thể chèn
# create a variable
name = 'Eric Cartman'
# print the value
print[name]
1 cho mỗi dòng:Thí dụ
#Đây là một bình luận#được viết bằng#không chỉ là một lineprint ["Xin chào, thế giới!"]
#written in
#more than just one line
print["Hello, World!"]
Hãy tự mình thử »
Hoặc, không hoàn toàn như dự định, bạn có thể sử dụng một chuỗi đa dòng.
Vì Python sẽ bỏ qua các chữ cái không được gán cho một biến, bạn có thể thêm một chuỗi đa dòng [trích dẫn ba] vào mã của bạn và đặt nhận xét của bạn bên trong nó:
Thí dụ
#Đây là một bình luận#được viết bằng#không chỉ là một lineprint ["Xin chào, thế giới!"]
This is a comment
written in
more than just one line
"""
print["Hello, World!"]
Hãy tự mình thử »
Hoặc, không hoàn toàn như dự định, bạn có thể sử dụng một chuỗi đa dòng.
Vì Python sẽ bỏ qua các chữ cái không được gán cho một biến, bạn có thể thêm một chuỗi đa dòng [trích dẫn ba] vào mã của bạn và đặt nhận xét của bạn bên trong nó:
Exercise:
"" "Đây là một bình luận được viết trong không chỉ một dòng" "" in ["Xin chào, thế giới!"]
Miễn là chuỗi không được gán cho một biến, Python sẽ đọc mã, nhưng sau đó bỏ qua nó và bạn đã đưa ra một nhận xét đa dòng.
Trong lập trình máy tính, nhận xét là những gợi ý mà chúng tôi sử dụng để làm cho mã của chúng tôi dễ hiểu hơn.
Nhận xét hoàn toàn bị bỏ qua bởi thông dịch viên. Chúng có nghĩa là cho các lập trình viên đồng nghiệp. Ví dụ,
# declare and initialize two variables
num1 = 6
num2 = 9
# print the output
print[' This is output']
Ở đây, chúng tôi đã sử dụng các nhận xét sau,
3# create a variable name = 'Eric Cartman' # print the value print[name]
4# create a variable name = 'Eric Cartman' # print the value print[name]
Các loại bình luận trong Python
Trong Python, có hai loại bình luận:
- Nhận xét một dòng
- Nhận xét đa dòng
Nhận xét một dòng trong Python
Một bình luận một dòng bắt đầu và kết thúc trong cùng một dòng. Chúng tôi sử dụng biểu tượng
# create a variable
name = 'Eric Cartman'
# print the value
print[name]
1 trong Python để viết một nhận xét một dòng. Ví dụ,# create a variable
name = 'Eric Cartman'
# print the value
print[name]
Đầu ra
Eric Cartman
Ở đây, chúng tôi đã tạo ra hai nhận xét một dòng:
6# create a variable name = 'Eric Cartman' # print the value print[name]
7# create a variable name = 'Eric Cartman' # print the value print[name]
Chúng tôi cũng có thể sử dụng nhận xét một dòng cùng với mã.
name = 'Eric Cartma' # name is a string
Ở đây, mã trước
# create a variable
name = 'Eric Cartman'
# print the value
print[name]
1 được thực thi và mã sau khi # create a variable
name = 'Eric Cartman'
# print the value
print[name]
1 bị thông dịch viên bỏ qua.Nhận xét đa dòng trong Python
Python không cung cấp một cách riêng để viết các bình luận đa dòng. Tuy nhiên, có nhiều cách khác để đi xung quanh vấn đề này.
Chúng ta có thể sử dụng
# create a variable
name = 'Eric Cartman'
# print the value
print[name]
1 ở đầu mỗi dòng bình luận trên nhiều dòng. Ví dụ,# This is a long comment
# and it extends
# to multiple lines
Ở đây, mỗi dòng được coi là một nhận xét duy nhất và tất cả chúng đều bị bỏ qua.
Một cách khác để làm điều này là sử dụng trích dẫn ba,
Eric Cartman1 hoặc
Eric Cartman2.
Các trích dẫn ba này thường được sử dụng cho các chuỗi nhiều dòng. Nhưng nếu chúng tôi không gán nó cho bất kỳ biến hoặc chức năng nào, chúng tôi có thể sử dụng nó như một nhận xét.
Trình thông dịch bỏ qua chuỗi không được gán cho bất kỳ biến hoặc hàm nào.
Hãy xem một ví dụ,
''' This is also a
perfect example of
multi-line comments '''
Ở đây, chuỗi đa dòng không được gán cho bất kỳ biến nào, do đó nó bị thông dịch bỏ qua. Mặc dù nó không phải là một nhận xét đa dòng, nó có thể được sử dụng như một.
Sử dụng bình luận Python
1. Làm cho mã dễ hiểu hơn
Nếu chúng tôi viết bình luận trong mã của chúng tôi, nó sẽ dễ dàng hơn cho tài liệu tham khảo trong tương lai.
Ngoài ra, sẽ dễ dàng hơn cho các nhà phát triển khác để hiểu mã.
2. Sử dụng nhận xét để gỡ lỗi
Nếu chúng tôi gặp lỗi trong khi chạy chương trình, chúng tôi có thể nhận xét dòng mã gây ra lỗi thay vì xóa nó. Ví dụ,
print['Python']
# print["Error Line ]
print['Django']
Ở đây,
Eric Cartman3 đã gây ra lỗi nên chúng tôi đã thay đổi nó như một nhận xét. Bây giờ, chương trình chạy mà không có bất kỳ lỗi nào.
Đây là cách bình luận có thể là một công cụ gỡ lỗi có giá trị.
Lưu ý: Luôn luôn sử dụng nhận xét để giải thích lý do tại sao chúng tôi đã làm điều gì đó hơn là cách chúng tôi làm điều gì đó. Nhận xét không nên là sự thay thế cho cách giải thích mã viết kém.: Always use comments to explain why we did something rather than how we did something. Comments shouldn't be the substitute for the way to explain poorly written code.
Tóm tắt: Trong hướng dẫn này, bạn sẽ học cách thêm nhận xét vào mã của mình. Và bạn sẽ học các loại bình luận Python bao gồm các bình luận khối, nhận xét nội tuyến và chuỗi tài liệu.: in this tutorial, you’ll learn how to add comments to your code. And you’ll learn various kinds of Python comments including block comments, inline comments, and documentation string.
Giới thiệu về Bình luận Python
Đôi khi, bạn muốn ghi lại mã mà bạn viết. Ví dụ: bạn có thể muốn lưu ý tại sao một đoạn mã hoạt động. Để làm điều đó, bạn sử dụng các ý kiến.
Thông thường, bạn sử dụng nhận xét để giải thích & nbsp; công thức, thuật toán và logic kinh doanh phức tạp.
Khi thực hiện một chương trình, trình thông dịch Python bỏ qua các nhận xét và chỉ diễn giải mã.
Python cung cấp ba loại bình luận bao gồm bình luận khối, nhận xét nội tuyến và & nbsp; tài liệu & nbsp; chuỗi.
Một bình luận khối giải thích mã theo sau nó. Thông thường, bạn thụt một bình luận khối ở cùng cấp độ với khối mã.
Để tạo nhận xét khối, bạn bắt đầu với một dấu băm đơn [
# create a variable
name = 'Eric Cartman'
# print the value
print[name]
1] theo sau là một không gian duy nhất và một chuỗi văn bản. Ví dụ:Code language: Python [python]
# increase price by 5% price = price * 1.05
Python ý kiến nội tuyến
Khi bạn đặt một nhận xét trên cùng một dòng với một tuyên bố, bạn sẽ có một nhận xét nội tuyến.
Tương tự như nhận xét khối, một nhận xét nội tuyến bắt đầu bằng một dấu băm đơn [
# create a variable
name = 'Eric Cartman'
# print the value
print[name]
1] và được theo sau bởi một không gian và chuỗi văn bản.Ví dụ sau đây minh họa một nhận xét nội tuyến:
Code language: Python [python]
salary = salary * 1.02 # increase salary by 2%
Python Docstrings
Chuỗi tài liệu là một chuỗi theo nghĩa đen mà bạn đặt làm dòng đầu tiên trong một khối mã, ví dụ, một hàm.
Không giống như một nhận xét thông thường, một chuỗi tài liệu có thể được truy cập vào thời gian chạy bằng cách sử dụng & nbsp;
Eric Cartman6 thuộc tính trong đó
Eric Cartman7 là tên của hàm.
Thông thường, bạn sử dụng chuỗi tài liệu để tự động tạo tài liệu mã.
Chuỗi tài liệu được gọi là DocStrings.
Về mặt kỹ thuật, tài liệu không phải là ý kiến. Họ tạo ra các biến ẩn danh tham chiếu các chuỗi. Ngoài ra, họ không bị bỏ qua bởi thông dịch viên Python.
Python cung cấp hai loại tài liệu: tài liệu một dòng và tài liệu đa dòng.
1] Tài liệu một dòng
Như tên của nó ngụ ý, một tài liệu một dòng phù hợp với một dòng. Một tài liệu một dòng bắt đầu với trích dẫn ba [
Eric Cartman2] và cũng kết thúc bằng trích dẫn ba [
Eric Cartman2]. Ngoài ra, đã giành được bất kỳ dòng trống nào trước hoặc sau tài liệu một dòng.
Ví dụ sau đây minh họa một dòng & nbsp; DocString in & nbsp; hàm
name = 'Eric Cartma' # name is a string
0:Code language: Python [python]
def quicksort[]: """ sort the list using quicksort algorithm """ ...
2] Tài liệu đa dòng
Không giống như một tài liệu một dòng, một tài liệu đa dòng có thể kéo dài nhiều dòng. Một tài liệu đa dòng cũng bắt đầu với trích dẫn ba [
Eric Cartman2] và kết thúc bằng trích dẫn ba [
Eric Cartman2].
Ví dụ sau đây cho bạn biết cách sử dụng tài liệu đa dòng:
# create a variable
name = 'Eric Cartman'
# print the value
print[name]
0Python nhận xét đa dòng
Python không hỗ trợ các bình luận đa dòng.
Tuy nhiên, bạn có thể sử dụng các tài liệu đa dòng làm nhận xét đa dòng. Guido Van Rossum, người tạo ra Python, cũng đề nghị điều này.
Đó là một thực hành tốt để giữ cho bình luận của bạn rõ ràng, súc tích và giải thích. Mục tiêu cuối cùng là tiết kiệm thời gian và năng lượng cho & nbsp; bạn và các nhà phát triển khác sẽ làm việc theo mã sau này.
Bản tóm tắt
- Sử dụng nhận xét để ghi lại mã của bạn khi cần thiết.
- Một bình luận khối và bình luận nội tuyến bắt đầu với một dấu hiệu băm [
1].# create a variable name = 'Eric Cartman' # print the value print[name]
- Sử dụng DocStrings cho các chức năng, & NBSP; các mô -đun và các lớp.
Bạn có thấy hướng dẫn này hữu ích không?