Hướng dẫn multiline comment in python - bình luận nhiều dòng trong python

Hướng dẫn multiline comment in python - bình luận nhiều dòng trong python

Nhận xét là một phần không thể thiếu của mọi ngôn ngữ lập trình. Với ý kiến, bạn hiểu rõ hơn về mã của riêng bạn, làm cho nó dễ đọc hơn và có thể giúp các thành viên trong nhóm hiểu cách thức hoạt động của nó.

Nhận xét bị bỏ qua bởi các trình biên dịch và phiên dịch viên, vì vậy họ không chạy.

Ngoài việc làm cho mã của bạn dễ đọc hơn, các bình luận cũng có thể giúp ích trong khi bạn gỡ lỗi - nếu bạn có hai dòng mã, bạn có thể nhận xét một để ngăn chặn nó chạy.

Cũng giống như các ngôn ngữ lập trình khác, Python hỗ trợ bình luận.

Vấn đề là Python không có cơ chế tích hợp cho các bình luận đa dòng.

Vì vậy, trong bài viết này, tôi sẽ không chỉ cho bạn cách đưa ra các bình luận một dòng trong Python-Tôi cũng sẽ cho bạn xem cách giải quyết để đưa ra các nhận xét đa dòng.

Để thực hiện các nhận xét một dòng trong Python, hãy dành cho mỗi dòng bằng một hàm băm (

Hello campers
6).

# print("Hello world")

print("Hello campers")

Output:

Hello campers

Như bạn có thể thấy, dòng nhận xét không được in trong đầu ra.

Không giống như các ngôn ngữ lập trình khác như JavaScript, Java và C ++ sử dụng

Hello campers
7 cho các nhận xét đa dòng, không có cơ chế tích hợp nào cho các nhận xét đa dòng trong Python.

Để nhận xét nhiều dòng trong Python, bạn có thể dành cho mỗi dòng bằng một hàm băm (

Hello campers
6).

# print("Hello world")
# print("Hello universe")
# print("Hello everyone")

print("Hello campers")

Output:

Hello campers

Với cách tiếp cận này, về mặt kỹ thuật bạn đang đưa ra nhiều bình luận một dòng.

Cách giải quyết thực sự để đưa ra các bình luận đa dòng trong Python là bằng cách sử dụng DocStrings.docstrings.

Nếu bạn sử dụng một tài liệu để nhận xét nhiều dòng mã trong Python, khối mã đó sẽ bị bỏ qua và chỉ các dòng bên ngoài DocString sẽ chạy.

"""
This is a multi-line comment with docstrings

print("Hello world")
print("Hello universe")
print("Hello everyone")
"""

print("Hello campers")

Output:

Hello campers

NB: Một điều cần lưu ý là trong khi sử dụng DoctSrings để bình luận, thụt lề vẫn còn quan trọng. Nếu bạn sử dụng 4 khoảng trống (hoặc một tab) để thụt vào, bạn sẽ gặp lỗi thụt lề. One thing to note is that while using doctsrings for commenting, indentation still matters. If you use 4 spaces (or a tab) for indentation, you will get an indentation error.

Ví dụ, điều này sẽ hoạt động:

def addNumbers(num1, num2, num3):
    """
    A function that returns the sum of
    3 numbers
    """
    return num1 + num2 + num3
print(addNumbers(2, 3, 4))

# Output: 9

Nhưng điều này sẽ không hoạt động:

def addNumbers(num1, num2, num3):
"""
A function that returns the sum of
3 numbers
"""
    return num1 + num2 + num3
print(addNumbers(2, 3, 4))

Vì vậy, IDE của bạn sẽ ném lỗi "

Hello campers
9".

Sự kết luận

Vì không có hỗ trợ tích hợp cho các bình luận đa dòng trong Python, bài viết này cho thấy cách bạn có thể sử dụng Docstrings như một cách giải quyết.

Tuy nhiên, bạn thường nên sử dụng các nhận xét Python thông thường bằng cách sử dụng hàm băm (

Hello campers
6), ngay cả khi bạn phải sử dụng nó cho nhiều dòng. Điều này là do Docstrings có nghĩa là cho tài liệu, và không để nhận xét mã.

Nếu bạn thấy bài viết này hữu ích, hãy xem xét chia sẻ nó với bạn bè và gia đình của bạn.

Cảm ơn bạn đã đọc.



Học mã miễn phí. Chương trình giảng dạy nguồn mở của Freecodecamp đã giúp hơn 40.000 người có được việc làm với tư cách là nhà phát triển. Bắt đầu

Chúng ta thường cần nhận xét khối mã trong Python trong khi kiểm tra hoặc gỡ lỗi mã. Khi một khối được biến thành một nhận xét Python, nó không đóng góp trong đầu ra của chương trình và giúp xác định hàm hoặc khối nào đang tạo ra lỗi trong chương trình. Trong bài viết này, chúng tôi sẽ xem xét một số lối tắt để nhận xét nhiều dòng mã cùng một lúc trong các id python khác nhau. Hãy xem ví dụ cho từng IDE một.

Trong Spyder Python IDE, chúng ta có thể nhận xét một dòng mã duy nhất bằng cách chọn dòng và sau đó sử dụng kết hợp khóa

# print("Hello world")
# print("Hello universe")
# print("Hello everyone")

print("Hello campers")
1. Điều này sẽ biến dòng đơn được chọn thành một nhận xét như được hiển thị bên dưới. Hàm được đưa ra trong ví dụ thêm một số và hình vuông của nó vào từ điển Python là cặp giá trị khóa.

print("This line will be commented out.")
def add_square_to_dict(x,mydict):
    a=x*x
    mydict[str(x)]=a
    return mydict
    

Sau khi nhấn

# print("Hello world")
# print("Hello universe")
# print("Hello everyone")

print("Hello campers")
1:

#print("This line will be commented out.")
def add_square_to_dict(x,mydict):
    a=x*x
    mydict[str(x)]=a
    return mydict
    

Phím tắt để nhận xét nhiều dòng mã trong Spyder IDE trước tiên là chọn tất cả các dòng cần được nhận xét và sau đó nhấn Ctrl+4 kết hợp chính. Điều này biến toàn bộ các dòng được chọn thành một nhận xét Python như được hiển thị bên dưới.

Hello campers
0

Sau khi nhấn Ctrl+4:

Hello campers
1

Chúng tôi cũng có thể sử dụng

# print("Hello world")
# print("Hello universe")
# print("Hello everyone")

print("Hello campers")
1 để giải nén các dòng sau khi chọn chúng khi chúng được bình luận hoặc nhận xét các dòng sau khi chọn chúng để nhận xét chúng. Trong một số phiên bản của Spyder
# print("Hello world")
# print("Hello universe")
# print("Hello everyone")

print("Hello campers")
4 có thể được sử dụng để giải phóng các dòng mã.

Để nhận xét một khối mã trong IDLE, trước tiên chúng ta phải chọn dòng và sau đó nhấn kết hợp khóa Ctrl+d. Điều này sẽ nhận xét các dòng mã được chọn như hình dưới đây.

Hello campers
2

Sau khi nhấn

# print("Hello world")
# print("Hello universe")
# print("Hello everyone")

print("Hello campers")
5:

Hello campers
3

Để giải phóng các dòng mã, chúng ta chỉ cần chọn các dòng và sau đó nhấn

# print("Hello world")
# print("Hello universe")
# print("Hello everyone")

print("Hello campers")
6. Điều này sẽ giải phóng các dòng được chọn.

Chúng ta có thể sử dụng Ctrl+/ để nhận xét các dòng được chọn của mã Python trong Notebook Jupyter. Điều này biến các dòng mã được chọn thành bình luận như được hiển thị bên dưới.

Hello campers
4

Sau khi nhấn

# print("Hello world")
# print("Hello universe")
# print("Hello everyone")

print("Hello campers")
7:

Hello campers
5

Để giải phóng các dòng được chọn, chúng ta chỉ cần nhấn một lần nữa

# print("Hello world")
# print("Hello universe")
# print("Hello everyone")

print("Hello campers")
7.

Nếu chúng ta phải nhận xét nhiều dòng mã trong pycharm, chúng ta có thể chọn các dòng để được nhận xét và sau đó nhấn

# print("Hello world")
# print("Hello universe")
# print("Hello everyone")

print("Hello campers")
9. Để giải nén các dòng, chúng ta chỉ cần chọn các dòng và sau đó nhấn lại
# print("Hello world")
# print("Hello universe")
# print("Hello everyone")

print("Hello campers")
9.

Sự kết luận

Trong bài viết này, chúng tôi đã thấy các phím tắt để nhận xét nhiều dòng cùng một lúc trong các ides khác nhau như Spyder, Idle, Jupyter Notebook và Pycharm. Hãy theo dõi các bài viết nhiều thông tin hơn.

Khuyến nghị đào tạo Python

Khóa học: Python 3 cho người mới bắt đầu

Hơn 15 giờ nội dung video với hướng dẫn hướng dẫn cho người mới bắt đầu. Tìm hiểu làm thế nào để tạo các ứng dụng trong thế giới thực và làm chủ những điều cơ bản.

Để nhận xét nhiều dòng trong Python, bạn có thể dành cho mỗi dòng bằng một hàm băm ( #).prepend each line with a hash ( # ).

Chúng ta có thể sử dụng Ctrl+/ để nhận xét các dòng được chọn của mã Python trong Notebook Jupyter.Điều này biến các dòng mã được chọn thành bình luận như được hiển thị bên dưới.Để giải nén các dòng đã chọn, chúng ta chỉ cần nhấn lại Ctrl+/.ctrl+/ to comment out the selected lines of python code in Jupyter Notebook. This turns selected lines of code into comment as shown below. To uncomment the selected lines, we just have to again press ctrl+/ .

Nhấn Ctrl + K.Ctrl + K .