Hướng dẫn how do i comment in python pycharm? - làm cách nào để nhận xét trong python pycharm?

Tạo nhận xét tài liệu cho các chức năng Python

Để tạo nhận xét tài liệu cho chức năng Python

  1. Đặt Caret sau khi khai báo một chức năng bạn muốn ghi lại.after the declaration of a function you want to document.

  2. Loại mở đầu trích dẫn ba, và nhấn Enter, hoặc không gian.

  3. Thêm mô tả có ý nghĩa về các tham số và giá trị trả về.

Để tạo nhận xét tài liệu cho chức năng Python bằng cách sử dụng hành động ý định

  1. Đặt Caret ở đâu đó trong chức năng bạn muốn ghi lại.

  2. Nhấn Alt+Enter để hiển thị các hành động có ý định có sẵn.

  3. Chọn Chèn Stub Chất Tài liệu:Insert documentation string stub:

    Hướng dẫn how do i comment in python pycharm? - làm cách nào để nhận xét trong python pycharm?

    Pycharm tạo ra tài liệu bình luận sơ khai theo định dạng DocString, được chọn trong trang Công cụ tích hợp Python.

Ví dụ về nhận xét Python

Xem xét chức năng sau:

xử lý def (tự, myparam1, myparam2):

Mở cài đặt Ctrl+Alt+S và điều hướng đến.

Trong thả xuống định dạng DocString, chọn epytext:Docstring format dropdown, select Epytext:

Hướng dẫn how do i comment in python pycharm? - làm cách nào để nhận xét trong python pycharm?

Sau đó nhập trích dẫn ba mở và nhấn Enter hoặc Space. Pycharm tạo ra một sơ khai nhận xét tài liệu ở định dạng epytext:Epytext format:

'' '@param self: @param myparam1: @param myparam2: @return:' ''

Quay trở lại trang Công cụ tích hợp Python trong Cài đặt (CTRL+ALT+S) và chuyển định dạng DocString sang ResformuredText. Sau đó nhập trích dẫn ba mở và nhấn Enter hoặc Space. Pycharm tạo ra một sơ khai nhận xét tài liệu ở định dạng ReserfuredText:Python Integrated Tools page in settings (Ctrl+Alt+S) and switch Docstring format to reStructuredText. Then type the opening triple quotes and press Enter or Space. PyCharm generates a documentation comment stub in reStructuredText format:

'' '

Sửa đổi lần cuối: 19 tháng 9 năm 2022

Ngôn ngữ Python không có cú pháp nhận xét đa dòng nội bộ (như \ *, * \ trong các ngôn ngữ khác). Có hai cách để giải quyết điều này:

  1. Sử dụng cú pháp theo nghĩa đen của chuỗi đa dòng: & nbsp; ′ ′ ′ ′ ′

'' '

Đây là nhận xét đa dòng

Hàng nhận xét thứ hai

'' '

Đây là nhận xét đa dòng

  1. Hàng nhận xét thứ haiCtrl + / to comment all of them.

Nhược điểm của cách này là nhận xét đó vẫn không đổi và được xử lý trong mã hoàn thành.Ctrl + / again.

Bạn đang ở đây: Trang chủ/ Nhận xét/ Phím tắt để bình luận nhiều dòng trong PythonHome / Comments / Shortcut to comment out multiple lines in Python

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 ctrl+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 ctrl+1:

Hướng dẫn how do i comment in python pycharm? - làm cách nào để nhận xét trong python pycharm?

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


  class MyNumber():
      """This is the docstring of this class.
      
      It describes what this class does and all its attributes."""
      def __init__(self, value):
          self.value=value
      def increment(self):
          """This is the docstring for this method.
          
          It describes what the method does, what are its calling conventions and
          what are its side effects"""
          self.value=self.value+1
          return self.value
  print (MyNumber.increment.__doc__)

Sau khi nhấn Ctrl+4:

# =============================================================================
# 
#   class MyNumber():
#       """This is the docstring of this class.
#       
#       It describes what this class does and all its attributes."""
#       def __init__(self, value):
#           self.value=value
#       def increment(self):
#           """This is the docstring for this method.
#           
#           It describes what the method does, what are its calling conventions and
#           what are its side effects"""
#           self.value=self.value+1
#           return self.value
#   print (MyNumber.increment.__doc__)
# =============================================================================

Chúng tôi cũng có thể sử dụng ctrl+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("This line will be commented out.")
def add_square_to_dict(x,mydict):
    a=x*x
    mydict[str(x)]=a
    return mydict
    
1 có thể được sử dụng để giải nén các dòng mã.

Lối tắt để nhận xét nhiều dòng trong Idle

Để 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.

 class MyNumber():
         """This is the docstring of this class.
         
         It describes what this class does and all its attributes."""
         def __init__(self, value):
             self.value=value
         def increment(self):
             """This is the docstring for this method.
             
             It describes what the method does, what are its calling conventions and
             what are its side effects"""
             self.value=self.value+1
             return self.value
     print (MyNumber.increment.__doc__)

Sau khi nhấn

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

## class MyNumber():
##         """This is the docstring of this class.
##         
##         It describes what this class does and all its attributes."""
##         def __init__(self, value):
##             self.value=value
##         def increment(self):
##             """This is the docstring for this method.
##             
##             It describes what the method does, what are its calling conventions and
##             what are its side effects"""
##             self.value=self.value+1
##             return self.value
##     print (MyNumber.increment.__doc__)

Để 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("This line will be commented out.")
def add_square_to_dict(x,mydict):
    a=x*x
    mydict[str(x)]=a
    return mydict
    
3. Điều này sẽ giải phóng các dòng được chọn.

Phím tắt để nhận xét nhiều dòng trong Notebook Jupyter

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.


     class MyNumber():
         """This is the docstring of this class.
         
         It describes what this class does and all its attributes."""
         def __init__(self, value):
             self.value=value
         def increment(self):
             """This is the docstring for this method.
             
             It describes what the method does, what are its calling conventions and
             what are its side effects"""
             self.value=self.value+1
             return self.value
     print (MyNumber.increment.__doc__)

Sau khi nhấn

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


#      class MyNumber():
#          """This is the docstring of this class.
         
#          It describes what this class does and all its attributes."""
#          def __init__(self, value):
#              self.value=value
#          def increment(self):
#              """This is the docstring for this method.
             
#              It describes what the method does, what are its calling conventions and
#              what are its side effects"""
#              self.value=self.value+1
#              return self.value
#      print (MyNumber.increment.__doc__)

Để 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("This line will be commented out.")
def add_square_to_dict(x,mydict):
    a=x*x
    mydict[str(x)]=a
    return mydict
    
4.

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

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("This line will be commented out.")
def add_square_to_dict(x,mydict):
    a=x*x
    mydict[str(x)]=a
    return mydict
    
6. Để 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("This line will be commented out.")
def add_square_to_dict(x,mydict):
    a=x*x
    mydict[str(x)]=a
    return mydict
    
6.

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.