Làm cách nào để bạn nhận xét nhiều dòng trong python pycharm?

Thêm nhận xét vào mã Python của chúng tôi là một nhiệm vụ quan trọng mà nhiều lập trình viên đã quen thuộc. Thường xuyên hơn không, chúng tôi thấy rằng chúng tôi cần thêm nhận xét nhiều dòng vào mã của mình bằng Python

Đáng ngạc nhiên, thực sự không có giải pháp vượt trội nào để thêm nhận xét nhiều dòng trong Python. Hai cách giải quyết mà chúng ta có thể sử dụng để thêm nhận xét nhiều dòng là thêm dấu # cho mỗi dòng nhận xét hoặc sử dụng chuỗi trích dẫn ba lần

Trong bài đăng này và video tiếp theo, chúng tôi sẽ thảo luận về hai cách giải quyết và giải thích lý do tại sao một chuỗi được trích dẫn ba lần thực sự không phải là một nhận xét [và cách chúng tôi có thể ngăn trình thông dịch hiểu nó là không có nhận xét]. Chúng ta cũng sẽ thảo luận về cách chúng ta có thể sử dụng phím tắt để nhận xét nhiều dòng mã trong Python

Mục lục

• Thêm # cho mỗi dòng nhận xét
  • Phím tắt để thêm nhận xét nhiều dòng
• Sử dụng ba chuỗi trích dẫn
  • Chuỗi trích dẫn ba về mặt kỹ thuật không phải là nhận xét
  • Hiển thị tài liệu
  • Sử dụng Chuỗi trích dẫn ba làm Nhận xét
  • Vấn đề thụt đầu dòng

Thêm # cho mỗi dòng nhận xét

Phương pháp đầu tiên để thêm nhiều dòng nhận xét trong mã Python của chúng tôi là thêm một

# This is a long comment
# that spans more
# than one line

5 cho mỗi dòng. Chẳng hạn, nếu chúng ta muốn khối văn bản sau đây là một bình luận

This is a long comment
that spans more
than one line

Chúng tôi làm điều đó như sau

# This is a long comment
# that spans more
# than one line

Khi chúng tôi thêm một

# This is a long comment
# that spans more
# than one line

5 trước mỗi dòng văn bản, chúng tôi biến dòng đó thành một bình luận. Do đó, khối văn bản trên thay đổi một cách hiệu quả thành ba dòng bình luận

Phím tắt để thêm nhận xét nhiều dòng

Trong hầu hết các trường hợp, trình soạn thảo văn bản hoặc IDE mà bạn sử dụng có thể chuyển đổi các khối văn bản thành nhận xét. Chẳng hạn, nếu bạn sử dụng IDLE, bạn có thể chọn văn bản mà bạn muốn chuyển thành nhận xét và nhấn Alt-3 trên bàn phím [tùy chọn-3 cho Mac OS]

IDLE sau đó sẽ thêm hai

# This is a long comment
# that spans more
# than one line

5 vào mỗi dòng của văn bản đã chọn để chuyển đổi chúng thành nhận xét [một

# This is a long comment
# that spans more
# than one line

5 là đủ, nhưng IDLE thêm hai, điều này cũng tốt]

Ngoài ra, bạn có thể chọn văn bản và nhấp vào Format > Comment Out Region trong thanh menu

Sau khi chuyển đổi văn bản thành nhận xét, nếu bạn muốn chuyển đổi nhận xét trở lại thành văn bản, bạn có thể chọn nhận xét và nhấn Alt-4 hoặc tùy chọn-4. Ngoài ra, bạn có thể nhấp vào Format > Uncomment Region trong thanh menu

Sử dụng ba chuỗi trích dẫn

Một phương pháp khác để thêm nhận xét nhiều dòng vào mã Python của bạn là sử dụng chuỗi trích dẫn ba lần. Chẳng hạn, để chuyển đổi khối văn bản sau thành nhận xét,

You can convert a block
of text to a comment by
using triple quotes.

Chúng ta có thể đặt khối bằng ba dấu nháy đơn [_______ 09] hoặc dấu nháy kép [________ 60], như minh họa trong các ví dụ bên dưới

'''
You can convert a block
of text to a comment by
using triple quotes.
'''

This is a long comment
that spans more
than one line

0

Chuỗi trích dẫn ba về mặt kỹ thuật không phải là nhận xét

Tuy nhiên, khi chúng tôi sử dụng các chuỗi trích dẫn ba lần, về mặt kỹ thuật, chúng không phải là nhận xét. Tùy thuộc vào vị trí chúng xuất hiện trong mã của bạn, chúng có thể được coi là chuỗi tài liệu và không bị trình thông dịch bỏ qua

Chuỗi tài liệu là một chuỗi tài liệu có thể được thêm vào các mô-đun, hàm, lớp và phương thức Python của chúng tôi để giải thích chức năng của mã [chứ không phải mã thực hiện như thế nào]. Các chuỗi này không bị trình thông dịch bỏ qua và có thể được truy cập bằng cách sử dụng thuộc tính

You can convert a block
of text to a comment by
using triple quotes.

1 của một đối tượng hoặc sử dụng hàm

You can convert a block
of text to a comment by
using triple quotes.

2 tích hợp

Bất kỳ chuỗi trích dẫn ba lần nào xuất hiện dưới dạng câu lệnh đầu tiên của mô-đun, hàm, lớp hoặc phương thức đều được coi là chuỗi tài liệu

Chẳng hạn, nếu chúng ta có chức năng sau

This is a long comment
that spans more
than one line

3

Dòng 3 và 4 là một chuỗi tài liệu

Hiển thị tài liệu

Để hiển thị chuỗi tài liệu, chúng ta có thể sử dụng một thuộc tính đặc biệt có tên là

You can convert a block
of text to a comment by
using triple quotes.

1

This is a long comment
that spans more
than one line

5

Điều này mang lại cho chúng tôi đầu ra sau

This is a long comment
that spans more
than one line

6

Ngoài ra, chúng ta có thể sử dụng chức năng

You can convert a block
of text to a comment by
using triple quotes.

2 tích hợp

This is a long comment
that spans more
than one line

8

Điều này mang lại cho chúng tôi đầu ra sau

This is a long comment
that spans more
than one line

9

Sử dụng Chuỗi trích dẫn ba làm Nhận xét

Bất kỳ chuỗi trích dẫn ba lần nào xuất hiện dưới dạng câu lệnh đầu tiên trong hàm đều được coi là chuỗi tài liệu. Ngược lại, nếu chúng ta di chuyển chuỗi xuống dưới, thì nó không còn là chuỗi tài liệu và bị trình thông dịch bỏ qua. Chẳng hạn, nếu chúng ta có chức năng sau

# This is a long comment
# that spans more
# than one line

0

Chuỗi trích dẫn ba lần trên dòng 5 và 6 KHÔNG phải là chuỗi tài liệu vì chúng xuất hiện sau câu lệnh đầu tiên

Chuỗi này bị trình thông dịch bỏ qua và hoạt động như một nhận xét. Nếu chúng tôi cố gắng hiển thị thuộc tính

You can convert a block
of text to a comment by
using triple quotes.

1

# This is a long comment
# that spans more
# than one line

1

chúng tôi sẽ nhận được

# This is a long comment
# that spans more
# than one line

2

như đầu ra

Vấn đề thụt đầu dòng

Khi sử dụng chuỗi ba trích dẫn làm nhận xét, trích dẫn ba ở đầu phải được thụt vào một cách thích hợp để tránh

You can convert a block
of text to a comment by
using triple quotes.

6