Nhận xét là một đoạn văn bản trong một chương trình không được thực thi. Nó có thể được sử dụng để cung cấp thông tin bổ sung nhằm hỗ trợ việc hiểu mã
Trong Python, ký tự #
được sử dụng để bắt đầu bình luận. Nhận xét tiếp tục sau #
cho đến hết dòng
Python không có cú pháp cụ thể cho nhận xét nhiều dòng, không giống như một số ngôn ngữ khác
Thay vào đó, có thể sử dụng nhiều ký tự #
Một cách khác, ít chính thức hơn để viết bình luận trong Python là sử dụng một chuỗi nhiều dòng. Python sẽ bỏ qua các ký tự chuỗi không được gán cho một biến, do đó, các chuỗi nhiều dòng [được tạo bởi văn bản bao quanh với ba dấu ngoặc kép """
] có thể được sử dụng làm nhận xét thực tế
Trong lập trình, mỗi dòng của chương trình mô tả trình tự các bước cần thiết để đạt được kết quả đầu ra. Đầu ra này có thể dựa trên một số đầu vào do người dùng cung cấp. Một số dòng của chương trình có thể dễ dàng và tự giải thích. Tuy nhiên, một số dòng có thể hơi phức tạp, chẳng hạn như vòng lặp for hoặc lệnh gọi hàm. Người khác đọc mã có thể thấy khó hiểu. Đó là nơi nhận xét có ích
Nhận xét được sử dụng để chỉ định ý nghĩa của một dòng cụ thể. Điều này giúp bạn dễ dàng hiểu nó khi bạn đọc nó sau này. Hơn nữa, những người khác cũng có thể đọc các nhận xét và hiểu mã của bạn
Trong Python, bạn có thể viết nhận xét sau khi đặt ký hiệu # trước nó. Chúng ta hãy xem xét các cách khác nhau để bình luận trong Python
Nhận xét tốt và xấu trong lập trình
Trong khi viết mã, bạn có thể viết nhận xét sau mỗi dòng mã nếu muốn. Nhưng điều đó không nhất thiết hữu ích. Có một sự khác biệt giữa những bình luận hữu ích và vô ích. Một bình luận có thể được gọi là hữu ích nếu nó ngắn gọn, đơn giản và giải thích một dòng mã cụ thể
Ví dụ, nhìn vào nhận xét sau
word = "Python" # A variable word that has been assigned a string value of "Python"
Đây không phải là một bình luận rất hữu ích. Điều này là do bạn có thể dễ dàng hiểu từ dòng mã rằng biến từ có giá trị là Python. Không cần bình luận ở đây
Kiểm tra ví dụ khác này
# An if statement checking whether the variable word is not present in the word_list
if word not in word_list:
print[“Not found”]
Vì câu lệnh if ở đây hơi phức tạp nên chú thích ở đây chỉ rõ chức năng của nó
Trong Python, có hai loại bình luận
Nhận xét một dòng
Trong Python, các chú thích một dòng được sử dụng để chú thích các dòng mã đơn lẻ. Những nhận xét này bắt đầu bằng ký hiệu #. Biểu tượng sau đó được theo sau bởi văn bản giải thích dòng mã. Bạn có thể viết những nhận xét này bên cạnh một dòng mã hoặc bên trên nó
Ví dụ
# Python program for defining a single-line comment
print['Hello World!']
đầu ra
Hello World!
Trong ví dụ trên, khối mã bắt đầu bằng ký hiệu “#”. Điều này đánh dấu sự khởi đầu của nhận xét một dòng. Trình biên dịch python bỏ qua dòng này. Dòng duy nhất được thực thi là print[‘Hello World. ]
Theo Style Guide for Python Code [PEP8], các bình luận không được vượt quá 79 ký tự trên mỗi dòng. Trường hợp bình luận của bạn vượt quá giới hạn này thì nên ngắt thành nhiều dòng. Đối với nhận xét một dòng, khuyến nghị từ 70 đến 72 ký tự
Nhận xét nhiều dòng
Nếu bạn muốn viết bình luận nhiều dòng, có thể sử dụng bình luận nhiều dòng. Những nhận xét này có thể được sử dụng để mô tả một khối mã cụ thể. Nhận xét nhiều dòng có thể được khai báo bằng hai cách. Bạn có thể chỉ định những nhận xét này bằng cách sử dụng ''' [Ba dấu nháy đơn] hoặc """ [Ba dấu nháy kép]. Các trích dẫn được đề cập ở đầu và ở cuối các ý kiến
Chúng ta hãy xem xét một ví dụ
"""
This is a multi-line comment
written in
more than just one line
"""
'''
This is another multi-line comment
written in
more than just one line
'''
print["Hello, World!"]
Làm cách nào để áp dụng hoặc xóa nhận xét khỏi chương trình bằng Python IDLE?
Nhận xét một dòng hoặc nhiều dòng mã
Các bước để nhận xét một dòng nhận xét bằng Python IDLE như sau
- Chọn các dòng trong chương trình mà bạn muốn bình luận
- Chuyển đến tab Định dạng trong IDLE
- Chọn Khu vực nhận xét hoặc nhấn Alt+3
- Để nhận xét nhiều dòng mã, hãy làm theo các bước tương tự
Bỏ ghi chú một dòng hoặc nhiều dòng mã
Các bước để bỏ ghi chú dòng mã như sau
- Chọn các dòng mã phải được nhận xét
- Chuyển đến tab Định dạng trong IDLE
- Nhấp vào vùng Bỏ ghi chú hoặc nhấn Alt+4
Phần kết luận
Nhận xét là điều cần thiết để tăng khả năng đọc mã của bạn. Điều này sẽ hữu ích khi bạn chia sẻ mã của mình với các lập trình viên khác. Thêm nhận xét là một kỹ năng hữu ích và không được lạm dụng. Vì vậy, tránh đặt nhận xét sau mỗi dòng mã