Trong hướng dẫn cập nhật đơn giản này, Tìm hiểu cách sử dụng hiệu quả các nhận xét bằng ngôn ngữ Python. Tìm hiểu các khái niệm cơ bản về nhận xét và các phương pháp hay nhất ngay bây giờ.

Bạn đang xem : cách nhận xét trong python

Được cập nhật vào tháng 7 năm 2021

Giới thiệu

Một kỹ năng quan trọng trong việc viết mã là khả năng sử dụng các nhận xét. Nhận xét là những dòng mà trình biên dịch và thông dịch viên bỏ qua mà các nhà phát triển sử dụng để để lại ghi chú về chức năng của mã. Ngoài ra, chúng cũng có thể được sử dụng để tắt các phần của mã.

Hướng dẫn này sẽ chỉ cho bạn cách sử dụng nhận xét bằng Python một cách hiệu quả.

Hướng dẫn về cách sử dụng nhận xét trong Python.

Điều kiện tiên quyết

  • Một môi trường lập trình Python hoạt động
  • Khả năng tạo và chỉnh sửa các tệp Python

Cú pháp Nhận xét Python

Để thêm hoặc đánh dấu một dòng làm nhận xét, hãy bắt đầu bằng dấu thăng ( # ) và dấu cách :

  # Đây là một nhận xét mẫu.  

Sử dụng dấu thăng để bắt đầu dòng yêu cầu hệ thống bỏ qua mọi thứ trong dòng đó. Khi ứng dụng chạy, chương trình giả vờ như những dòng đó không tồn tại. Tuy nhiên, bạn vẫn có thể thấy nó khi bạn chỉnh sửa tệp.

Ví dụ: trong chương trình Hello World bên dưới:

  # Hiển thị dòng chữ "Hello, World!" trên màn hình.
print ("Xin chào, Thế giới!")  

thêm nhận xét vào python script

Hệ thống chạy mã print (" Hello, World ") ở dòng thứ tư, trong khi dòng ở trên giải thích những gì mã phải làm.

Bạn có thể đặt bất kỳ dòng nào làm nhận xét và sử dụng bao nhiêu dòng tùy thích. Nếu mã của bạn có các khối khác nhau, bạn có thể sử dụng nhận xét để giải thích từng khối. Ví dụ:

  # Xác định biến hoa dưới dạng danh sách các chuỗi.
hoa = [‘hoa hồng’, ‘hoa cẩm chướng’, ‘daisy’, ‘cúc vạn thọ’, ‘tulip’, ‘hoa hướng dương’]

# Tạo vòng lặp for để lặp qua danh sách hoa và hiển thị từng mục chuỗi.
cho hoa trong hoa:
            print (hoa)  

cách thêm nhiều nhận xét trong python

Khối nhận xét trong Python

Chặn nhận xét là các nhận xét dạng dài hơn bao gồm nhiều dòng liên tiếp. Một nhà phát triển sử dụng chúng để giải thích những đoạn mã phức tạp hơn, đặc biệt là khi làm việc theo nhóm.

Để đánh dấu một loạt các dòng làm nhận xét, hãy thêm dấu thăng + dấu cách ở đầu mỗi dòng:

  # Đây là một nhận xét
# mà chạy tới
# nhiều dòng.  

Một số văn bản hoặc trình chỉnh sửa mã để lập trình (như Notepad ++ hoặc Atom) cho phép bạn đánh dấu văn bản, sau đó nhấp chuột để đánh dấu khối là một lời bình luận. Những công cụ này có thể giúp bạn tiết kiệm thời gian bình luận từng dòng.

Xem Thêm  Cách tạo thư viện hình ảnh với CSS Grid - cách tạo lưới ảnh trong html

Nhận xét Đa dòng trong Python

Nói chung, bạn nên sử dụng # ở đầu mỗi dòng để đánh dấu nó dưới dạng nhận xét. Tuy nhiên, nhận xét một phần lớn sẽ mất rất nhiều thời gian và bạn có thể cần một cách nhanh chóng để nhận xét toàn bộ phần. Trong những trường hợp như vậy, bạn có thể sử dụng nhận xét nhiều dòng .

Các chuỗi nhiều dòng không hoạt động như các chú thích Python truyền thống, vì không có chức năng nhiều dòng chính thức. Thay vào đó, hãy sử dụng các chuỗi nhiều dòng được bao bọc bên trong dấu ngoặc kép ( "" " ) để đạt được chức năng tương tự.

Ví dụ:

  def add_test (a, b):
    kết quả = a + b
    "" "
    Đây là một khối
    trong số các dòng đã nhận xét.
    Chúng không được trình biên dịch phân tích cú pháp và diễn giải.
    "" "
trả về kết quả  

cách có nhận xét nhiều dòng trong python

Lưu ý: Điều quan trọng là bạn phải thụt lề chính xác dấu ngoặc kép. Nếu không, bạn sẽ thấy lỗi cú pháp.

Phương thức này tạo ra một hằng số văn bản không có chức năng, không phải là một nhận xét đúng. Miễn là bạn không thêm bất kỳ thứ gì truy cập vào chuỗi văn bản đó, thì nó sẽ hoạt động giống như một nhận xét thông thường.

Dấu ngoặc kép có thể phức tạp vì trong một số trường hợp, dấu ngoặc kép tạo ra chuỗi tài liệu nếu dấu ngoặc kép:

  • theo sau chữ ký hàm,
  • theo định nghĩa lớp,
  • ở đầu mô-đun.

Nếu bạn đặt "" " ở một trong những nơi được liệt kê ở trên, Python sẽ đọc nó như một chuỗi tài liệu . Các chuỗi tài liệu cho phép bạn đặt con người – văn bản có thể đọc được vào dự án. Văn bản này thường được sử dụng để tạo tài liệu là một phần của ứng dụng và có thể được truy cập trong thời gian chạy.

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

Bạn có thể nhận xét trong cùng một dòng như một đoạn mã bằng cách sử dụng nhận xét nội dòng . Thời gian tốt nhất để sử dụng tùy chọn này là khi giải thích một hoạt động phức tạp.

Sử dụng nhận xét nội tuyến để chỉ ra điểm chính xác mà bạn muốn làm rõ. Thêm dấu thăng + dấu cách chuẩn để biểu thị nhận xét nội dòng:

Hàm

 
    đặt biến
    lệnh chạy
    chạy lệnh bổ sung # Phần thủ thuật: Chương trình bị ngắt nếu dòng này bị xóa.  

Nhận xét nội tuyến được sử dụng để thêm ngữ cảnh cho những người đọc mã. Ví dụ: bạn có thể giải thích mục đích của một biến hoặc để lại ghi chú về loại biến được tạo. Cũng có thể hữu ích khi giải thích lý do tại sao một lệnh cụ thể được sử dụng, như trong ví dụ trên.

Xem Thêm  Python Do While - Ví dụ về vòng lặp - ví dụ về vòng lặp python do while

nhận xét trên cùng một dòng với một đoạn mã

Nhận xét về Python

Vì các nhận xét hiển thị văn bản ẩn đối với trình phân tích cú pháp, bạn có thể sử dụng chúng để tắt các lệnh. Làm như vậy cho phép bạn kiểm tra các phân đoạn mã có và không có bổ sung mới.

Ví dụ: trong chương trình tung xúc xắc đơn giản này, có một phần được nhận xét. Nếu bạn xóa dấu thăng, bạn sẽ kích hoạt mã để kiểm tra nó.

  nhập ngẫu nhiên
tối thiểu = 1
tối đa = 6

roll_again = "có"

trong khi roll_again == "yes" hoặc roll_again == "y":
     in "Lăn xúc xắc ..."
     print "Các giá trị là ...."
     in random.randint (tối thiểu, tối đa)
     in random.randint (tối thiểu, tối đa)

# Cộng hai số ngẫu nhiên với nhau để có tổng
# while roll_again == “yes” hoặc roll_again == “y”:
    # print ”Lăn xúc xắc…”
    # print “Bạn đã lăn một“
    # print random.randint (tối thiểu, tối đa) + random.randint (tối thiểu, tối đa)

    roll_again = raw_input ("Tung xúc xắc lần nữa?")  

Tại sao nhận xét lại quan trọng trong Python

Nhận xét có thể giúp bạn:

  • Hiểu mã của riêng bạn khi bạn quay lại mã sau một khoảng thời gian dài hơn.
  • Giúp bạn sao lưu để tăng tốc nhanh hơn.
  • Gỡ lỗi.
  • Hiểu các lựa chọn mã nhất định khi làm việc trong nhóm.
  • Ngăn ngừa các vấn đề tiềm ẩn bằng cách nhấn mạnh lý do tại sao một phần mã cụ thể lại quan trọng.

Các phương pháp hay nhất về nhận xét mã Python

  • Nhận xét ở thụt lề giống như mã bạn đang đề cập đến. Điều này giúp bạn dễ dàng xem những gì bạn đang đề cập đến.
  • Cập nhật nhận xét khi bạn cập nhật mã của mình. Nhận xét không đúng còn tệ hơn không có nhận xét.
  • Sử dụng các câu hoàn chỉnh. Viết hoa các từ thích hợp, trừ khi bạn đang đề cập đến một số nhận dạng (như một biến). Không bao giờ thay đổi trường hợp của số nhận dạng.
  • Các nhận xét về khối phải được viết thành câu hoàn chỉnh, có dấu chấm. Nhắm mục tiêu 80 từ mỗi dòng trở xuống.
  • Nếu bạn có nhiều câu trong một nhận xét, hãy sử dụng dấu cách kép giữa các câu.
  • Viết nhận xét bằng tiếng Anh.
  • < li> Đối với nhận xét khối có nhiều đoạn văn, hãy thêm một dòng trống giữa các đoạn văn với một thẻ nhận xét trước dòng trống.

  • Đối với nhận xét nội dòng, hãy để lại ít nhất hai khoảng cách giữa mã và nhận xét. Sử dụng các nhận xét nội tuyến một cách tiết kiệm và tránh sử dụng chúng để thể hiện điều hiển nhiên.

TRÁNH:

  • Không nhận xét về mã tự giải thích. Hãy tuân thủ nguyên tắc viết DRY ( D on’t R epeat Y ourelf) và tránh Mã và nhận xét của WET ( W rite E verything T wice).
  • Tránh sử dụng nhận xét để giải thích mã lộn xộn – các nhận xét hỗ trợ mã không được biện minh cho nó.

Kết luận

Giờ bạn đã hiểu cách (và lý do) đưa ra nhận xét bằng ngôn ngữ Python.


Xem thêm những thông tin liên quan đến chủ đề làm thế nào để bình luận trong python

#6: Python Docstrings | Python Best Practices

alt

  • Tác giả: Programiz
  • Ngày đăng: 2021-04-07
  • Đánh giá: 4 ⭐ ( 8892 lượt đánh giá )
  • Khớp với kết quả tìm kiếm: Step by step video tutorials to learn Python for absolute beginners!

    Python docstrings provide a convenient way of associating documentation with Python modules, functions, classes, and methods.

    In this video, we will learn to create docstrings and understand how and why they should be used to write better Python code.

    ~
    Run Python Online: https://www.programiz.com/python-programming/online-compiler/
    Programs in this video: https://github.com/programiz/python-best-practices/blob/main/06-docstrings.md

    Python docstrings (text-based tutorial): https://www.programiz.com/python-programming/docstrings

    Watch our videos and revise them with our Python App!
    Download here for Android: https://bit.ly/learn-python-android
    Download here for iOS: https://apple.co/3iPm6Sx

    Timestamps:
    0:00 Intro
    0:18 Python Multiline comments
    1:28 Python docstrings
    4:34 How to write good docstrings?

    Find Programiz elsewhere:
    Facebook: https://www.facebook.com/programiz
    Instagram: https://www.instagram.com/_programiz/
    LinkedIn: https://www.linkedin.com/company/programiz
    Website: https://www.programiz.com

    programiz python pythondocstrings learnprogramming pythonbestpractices

Bắt đầu với Python

  • Tác giả: www.codehub.com.vn
  • Đánh giá: 5 ⭐ ( 6935 lượt đánh giá )
  • Khớp với kết quả tìm kiếm: Cài đặt Python trên Windows và Mac OSX, hướng dẫn tạo chương trình Python và cách chạy chương trình Python.

Làm thế nào để bình luận nhiều dòng trong Visual Studio Code?

  • Tác giả: qastack.vn
  • Đánh giá: 5 ⭐ ( 9354 lượt đánh giá )
  • Khớp với kết quả tìm kiếm: [Tìm thấy giải pháp!] Shift+ Alt+A Ở đây bạn có thể tìm thấy tất cả các phím tắt. Tất cả…

Cách ghi chú trong Python

  • Tác giả: howkteam.vn
  • Đánh giá: 3 ⭐ ( 5517 lượt đánh giá )
  • Khớp với kết quả tìm kiếm: Cách ghi chú trong Python

Làm thế nào để chuyển đổi ascii thành unicode trong Python?

  • Tác giả: www.banhoituidap.com
  • Đánh giá: 3 ⭐ ( 1530 lượt đánh giá )
  • Khớp với kết quả tìm kiếm:

Tạo Python Scatter Plot & Python BoxPlot

  • Tác giả: websitehcm.com
  • Đánh giá: 4 ⭐ ( 4619 lượt đánh giá )
  • Khớp với kết quả tìm kiếm: Tạo Python Scatter Plot & Python BoxPlot w3seo cách sửng dụng scatter Pllot và boxPlot trong python để vẽ đồ thì dữ liệu

Làm thế nào để sử dụng các hàm Python NumPy mean (), min () và max ()?

  • Tác giả: vi.softoban.com
  • Đánh giá: 5 ⭐ ( 2701 lượt đánh giá )
  • Khớp với kết quả tìm kiếm: Thư viện Python NumPy có nhiều hàm tổng hợp hoặc thống kê; mean (), max () và min () là ba trong số các hàm tổng hợp hữu ích nhất của nó, mục đích được giải thích ở đây. Các hàm tổng hợp khác là average (), sum (), median (), v.v. Bài viết này sẽ hướng dẫn bạn cách sử dụng ba hàm tổng hợp nhiều nhất với một số ví dụ.

Xem thêm các bài viết khác thuộc chuyên mục: Kiến thức lập trình

Xem Thêm  How to Fix: “Is Not Recognized as an Internal or External Command, Operable Program or Batch File” error - python is not recognized as an internal or external command operable program or batch file

By ads_php