Hướng dẫn what is a line comment in python? - một dòng bình luận trong python là gì?

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 (#) theo sau là một không gian duy nhất và một chuỗi văn bản. Ví dụ:

# increase price by 5%
price = price * 1.05
Code language: Python (python)

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 (#) 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:

salary = salary * 1.02   # increase salary by 2%
Code language: Python (python)

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; obj.__doc__ thuộc tính 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, 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 (

salary = salary * 1.02   # increase salary by 2%
Code language: Python (python)

Ví dụ sau đây minh họa một dòng & nbsp; DocString in & nbsp; hàm

salary = salary * 1.02   # increase salary by 2%
Code language: Python (python)

def quicksort():
""" sort the list using quicksort algorithm """
...
Code language: Python (python)

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 (

salary = salary * 1.02   # increase salary by 2%
Code language: Python (python)

Ví dụ sau đây cho bạn biết cách sử dụng tài liệu đa 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)

Python 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 (#).
• 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?