Hướng dẫn what are comments in python with example? - những bình luận trong python với ví dụ là gì?

Họ hoàn toàn bị bỏ qua bởi thông dịch viên Python.


Ưu điểm của việc sử dụng bình luận

Sử dụng nhận xét 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 tôi nhớ tại sao một số khối mã đượ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 chặn việc thực hiện một số dòng hoặc viết mã giả nhanh cho chương trình.


Nhận xét một dòng trong Python

Trong Python, chúng tôi sử dụng biểu tượng băm # để viết một nhận xét đơn lẻ.

Ví dụ 1: Viết nhận xét một dòng

# printing a string
print('Hello world')

Đầu ra

Hello world

Đây, nhận xét là:

# printing a string

Dòng này bị bỏ qua bởi thông dịch viên Python.

Tất cả mọi thứ đến sau khi # bị bỏ qua. Vì vậy, chúng tôi cũng có thể viết chương trình trên trong một dòng như:

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ả các văn bản sau #.Example 1. The interpreter ignores all the text after #.


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 # ở đầu mỗi dòng bình luận 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 là một nhận xét duy nhất và tất cả chúng đều bị bỏ qua.


Mặc dù không có cách nào duy nhất để viết các bình luận đa dòng trong Python, chúng tôi biết rằng trình thông dịch Python bỏ qua các chữ cá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 một dòng như:

#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 chức năng 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 các chuỗi đa dòng (trích dẫn ba) để viết nhận xét đa dòng.

Ký tự trích dẫn có thể là

Hello world
1 hoặc
Hello world
2.

Ví dụ 3: Sử dụng chuỗi chữ để viết nhận xét đa dòng

'''

I am a
multiline comment!

'''
print("Hello World")

Ở đâ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.


Python Docstrings

Theo quy ước, các trích dẫn ba xuất hiện ngay sau chức năng, phương thức hoặc định nghĩa lớp là tài liệu (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 thuộc tính

Hello world
3.

Để tìm hiểu thêm, hãy truy cập Python Docstrings.


  • Sử dụng nhận xét để mô tả những gì một chức năng làm và không phải các chi tiết cụ thể về cách chức năng thực hiện nó.
  • Cố gắng loại bỏ càng nhiều nhận xét dư 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 làm cho các ý kiến ​​càng ngắn và súc tích càng tốt.


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 # 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 # 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.



Xem bây giờ hướng dẫn này có một khóa học video liên quan được tạo bởi nhóm Python thực sự. Xem cùng với hướng dẫn bằng văn bản để hiểu sâu hơn về sự hiểu biết của bạn: viết bình luận bằng Python This tutorial has a related video course created by the Real Python team. Watch it together with the written tutorial to deepen your understanding: Writing Comments in Python

Khi viết mã bằng Python, điều quan trọng là đảm bảo rằng mã của bạn có thể dễ dàng hiểu được bởi người khác. Đặt các biến tên rõ ràng, xác định các chức năng rõ ràng và tổ chức mã của bạn là tất cả các cách tuyệt vời để làm điều này.your code can be easily understood by others. Giving variables obvious names, defining explicit functions, and organizing your code are all great ways to do this.

Một cách tuyệt vời và dễ dàng khác để tăng khả năng đọc mã của bạn là sử dụng bình luận!comments!

Trong hướng dẫn này, bạn sẽ đề cập đến một số điều cơ bản của việc viết bình luận bằng Python. Bạn sẽ học cách viết bình luận sạch sẽ và súc tích, và khi bạn có thể không cần phải viết bất kỳ bình luận nào.

Bạn cũng sẽ học:

  • Tại sao nó rất quan trọng để bình luận mã của bạn
  • Thực tiễn tốt nhất để viết bình luận bằng Python
  • Các loại bình luận bạn có thể muốn tránh
  • Cách thực hành viết bình luận sạch hơn

Sự kết luận

Học cách bình luận tốt là một công cụ có giá trị. Bạn sẽ không chỉ học cách viết rõ ràng và chính xác hơn nói chung, mà bạn cũng không nghi ngờ gì nữa, cũng có được sự hiểu biết sâu sắc hơn về Python.

Biết cách viết bình luận bằng Python có thể giúp cuộc sống dễ dàng hơn cho tất cả các nhà phát triển, bao gồm cả chính bạn! Họ có thể giúp các nhà phát triển khác có được tốc độ theo những gì mã của bạn làm và giúp bạn được đánh giá lại với mã cũ của riêng bạn.

Bằng cách nhận thấy khi bạn sử dụng các nhận xét để thử và hỗ trợ mã được viết kém, bạn sẽ có thể quay lại và sửa đổi mã của bạn để mạnh mẽ hơn. Nhận xét mã bằng văn bản trước đây, cho dù là nhà phát triển của riêng bạn hay một nhà phát triển khác, là một cách tuyệt vời để thực hành viết những bình luận sạch trong Python.

Khi bạn tìm hiểu thêm về việc ghi lại mã của mình, bạn có thể xem xét chuyển sang cấp độ tài liệu tiếp theo. Kiểm tra hướng dẫn của chúng tôi về tài liệu mã Python để thực hiện bước tiếp theo.

Xem bây giờ hướng dẫn này có một khóa học video liên quan được tạo bởi nhóm Python thực sự. Xem cùng với hướng dẫn bằng văn bản để hiểu sâu hơn về sự hiểu biết của bạn: viết bình luận bằng Python This tutorial has a related video course created by the Real Python team. Watch it together with the written tutorial to deepen your understanding: Writing Comments in Python

Ý bạn là gì khi nhận xét trong Python giải thích loại bình luận với ví dụ?

Nhận xét trong Python là các dòng trong mã bị thông dịch viên bỏ qua trong quá trình thực hiện chương trình.Nhận xét tăng cường khả năng đọc của mã và giúp các lập trình viên hiểu rất cẩn thận.Có ba loại ý kiến trong Python - bình luận dòng đơn.Nhận xét đa dòng.the lines in the code that are ignored by the interpreter during the execution of the program. Comments enhance the readability of the code and help the programmers to understand the code very carefully. There are three types of comments in Python – Single line Comments. Multiline Comments.

Những bình luận nào được sử dụng trong Python?

Một nhận xét trong Python bắt đầu với ký tự băm, # và mở rộng đến cuối dòng vật lý.Tuy nhiên, một ký tự băm trong một giá trị chuỗi không được xem là một nhận xét.starts with the hash character, # , and extends to the end of the physical line. A hash character within a string value is not seen as a comment, though.