Bạn có thể sử dụng để nhận xét bằng Python không?

Tóm lược. 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ẽ tìm hiểu các loại nhận xét Python khác nhau bao gồm nhận xét khối, nhận xét nội tuyến và chuỗi tài liệu

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 ý lý do 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 các công thức, thuật toán và logic kinh doanh phức tạp

Khi thực thi một chương trình, trình thông dịch Python sẽ bỏ qua các chú thích và chỉ diễn giải mã

Python cung cấp ba loại nhận xét bao gồm nhận xét khối, nhận xét nội tuyến và chuỗi tài liệu

Bình luận khối Python

Một bình luận khối giải thích mã theo sau nó. Thông thường, bạn thụt lề một khối nhận xét ở cùng cấp với khối mã

Để tạo một bình luận khối, bạn bắt đầu với một dấu thăng đơn [_______17_______], theo sau là một khoảng trắng và một chuỗi văn bản. Ví dụ

# increase price by 5%
price = price * 1.05
Code language: Python [python]

Nhận xét nội tuyến Python

Khi bạn đặt một nhận xét trên cùng một dòng với một câu lệnh, bạn sẽ có một nhận xét nội tuyến

Tương tự như một bình luận khối, một bình luận nội tuyến bắt đầu bằng một dấu thăng đơn [#] và theo sau là một khoảng trắng và một chuỗi văn bản

Ví dụ sau minh họa một nhận xét nội tuyến

salary = salary * 1.02   # increase salary by 2%
Code language: Python [python]

tài liệu Python

Chuỗi tài liệu là một chuỗi ký tự 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 trong thời gian chạy bằng cách sử dụng thuộc tính  obj.__doc__ trong đó obj 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, docstrings không phải là ý kiến. Họ tạo các biến ẩn danh tham chiếu các chuỗi. Ngoài ra, chúng không bị trình thông dịch Python bỏ qua

Python cung cấp hai loại docstrings. tài liệu một dòng và tài liệu nhiều dòng

1] Tài liệu một dòng

Đúng như tên gọi của nó, một chuỗi tài liệu một dòng phù hợp với một dòng. Chuỗi tài liệu một dòng bắt đầu bằng ba dấu ngoặc kép ["""] và cũng kết thúc bằng ba dấu ngoặc kép [_______21_______]. Ngoài ra, sẽ không có bất kỳ dòng trống nào trước hoặc sau chuỗi tài liệu một dòng

Ví dụ sau minh họa một chuỗi tài liệu một dòng trong hàm

salary = salary * 1.02   # increase salary by 2%
Code language: Python [python]

0

def quicksort[]:
""" sort the list using quicksort algorithm """
...
Code language: Python [python]

2] Tài liệu nhiều dòng

Không giống như chuỗi tài liệu một dòng, chuỗi tài liệu nhiều dòng có thể trải rộng trên nhiều dòng. Một chuỗi tài liệu nhiều dòng cũng bắt đầu bằng ba dấu ngoặc kép [_______21_______] và kết thúc bằng ba dấu ngoặc kép [_______21_______]

Ví dụ sau đây cho bạn thấy cách sử dụng chuỗi tài liệu nhiều dòng

def increase[salary, percentage, rating]:
    """ increase salary base on rating and percentage
    rating 1 - 2 no increase
    rating 3 - 4 increase 5%
    rating 4 - 6 increase 10%
    """
Code language: Python [python]

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

Python không hỗ trợ bình luận nhiều dòng

Tuy nhiên, bạn có thể sử dụng chuỗi tài liệu nhiều dòng làm nhận xét nhiều dòng. Guido van Rossum, người tạo ra Python, cũng khuyến nghị điều này

Đó là một thực hành tốt để giữ cho nhận xét của bạn rõ ràng, ngắn gọn 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 bạn và những nhà phát triển khác, những người sẽ làm việc với mã sau này

Nhận xét hoàn toàn bị bỏ qua bởi trình thông dịch. Chúng dành 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 ý kiến ​​​​sau đây,

• declare and initialize two variables
• print the output

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 nhiều dòng

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

Nhận xét 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 ký hiệu # để viết bình luận 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 hai nhận xét một dòng

1. # create a variable
   name = 'Eric Cartman'
   
   # print the value
   print[name]

   0

2. # create a variable
   name = 'Eric Cartman'
   
   # print the value
   print[name]

   1

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 Cartman' # name is a string

Ở đây, mã trước # được thực thi và mã sau # bị trình thông dịch bỏ qua

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

Python không cung cấp cách riêng để viết nhận xét nhiều dòng. Tuy nhiên, có nhiều 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ụ,

# 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 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 ba dấu ngoặc kép, hoặc là

# create a variable
name = 'Eric Cartman'

# print the value
print[name]

5 hoặc là

# create a variable
name = 'Eric Cartman'

# print the value
print[name]

6

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 ta không gán nó cho bất kỳ biến hoặc chức năng nào, chúng ta 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 nhiều dòng không được gán cho bất kỳ biến nào, vì vậy nó sẽ 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 bình luận nhiều dòng, như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 nhận xét trong mã của mình, việc tham khảo sau này sẽ dễ dàng hơn

Ngoài ra, các nhà phát triển khác sẽ dễ dàng hiểu mã hơn

2. Sử dụng Nhận xét để gỡ lỗi

Nếu gặp lỗi khi chạy chương trình, chúng ta có thể comment dòng code gây ra lỗi thay vì loại bỏ nó. Ví dụ,

print['Python']

# print['Error Line ]

print['Django']

Ở đây,

# create a variable
name = 'Eric Cartman'

# print the value
print[name]

7 đã gây ra lỗi nên chúng tôi đã thay đổi nó thành 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 nhận xét có thể là một công cụ sửa lỗi có giá trị

Ghi chú. Luôn sử dụng nhận xét để giải thích lý do tại sao chúng ta làm điều gì đó hơn là cách chúng ta làm điều gì đó. Nhận xét không nên thay thế để giải thích mã được viết kém

/* trong Python là gì?

Có hai cách để bình luận trong Python?

Các kiểu nhận xét trong Python là gì?

Ký tự nào được sử dụng cho nhận xét trong Python *?