Hướng dẫn how do you comment full code in python? - làm thế nào để bạn nhận xét mã đầy đủ trong python?

Trong bài viết này, chúng ta sẽ nói về các bình luận trong Python, tại sao chúng lại quan trọng và cách sử dụng chúng một cách hiệu quả trong mã của bạn.

Trong phần này, chúng ta sẽ nói về một số trường hợp sử dụng chung cho các bình luận. Chúng không chỉ áp dụng cho Python, mà là cho hầu hết các ngôn ngữ lập trình.

Dưới đây là một số lý do chính để nhận xét mã của bạn:

• Ngăn chặn thực thi mã: Trong một số trường hợp, bạn sẽ cần ngăn một phần mã của bạn chạy. Điều này có thể là do bạn không có ích cho mã đó vào lúc này, nhưng bạn muốn thêm nó cho chức năng trong tương lai.: In some cases, you'll need to prevent a part of your code from running. This may be because you have no use for that code at the moment, but you want to add it anyway for future functionality.
• Khả năng đọc: Điều này rất quan trọng - không chỉ cho bản thân chúng ta mà còn cho các nhà phát triển khác. Chúng tôi có thể sử dụng nhận xét để giải thích những gì mỗi khối mã làm. Điều này rất hữu ích khi các nhà phát triển khác đang đọc mã của chúng tôi, vì nó giúp dễ hiểu mỗi phần của mã làm gì.: This is very important – not just for ourselves but for other developers. We can use comments to explain what each code block does. This is useful when other developers are reading our code, as it makes it easy to understand what each part of the code does.

Cú pháp cho các bình luận khác nhau trong mỗi ngôn ngữ lập trình. Trong phần này, chúng ta sẽ xem cách thêm nhận xét bằng Python.

Nhận xét trong Python bắt đầu với biểu tượng

# print("Hello World!")
print("Happy coding!")

#The code below prints Hello World! to the console
print("Hello World!")

Trong mã trên, tôi đã sử dụng một bình luận để giải thích mã làm gì. Khi mã được thực thi, trình thông dịch sẽ bỏ qua nhận xét và chạy chức năng

# print("Hello World!")
print("Happy coding!")

Chúng tôi cũng có thể nhận xét mã thực tế. Đó là:

# print("Hello World!")
print("Happy coding!")

Khi chúng tôi chạy mã, chỉ có dòng thứ hai sẽ được giải thích.

Bạn không phải lúc nào cũng phải đặt nhận xét lên trên dòng mã họ đang tham khảo. Bạn cũng có thể đặt chúng trên cùng một dòng. Đó là:

print("Hello world") # Prints Hello World

Trong phần này, chúng ta sẽ xem cách viết bình luận trải dài trên nhiều dòng.

Không giống như hầu hết các ngôn ngữ lập trình khác, Python không có cú pháp tích hợp để tạo các nhận xét đa dòng.

May mắn thay, có hai cách chúng ta có thể làm việc xung quanh đó. Đây là lần đầu tiên:

# When this code runs,
# you will see Hello World! 
# in the console. 
print("Hello world")

Ở trên, chúng tôi đã đặt biểu tượng

# print("Hello World!")
print("Happy coding!")

Trong ví dụ tiếp theo này, chúng tôi sẽ sử dụng các chuỗi nhiều dòng (bắt đầu và kết thúc với ba dấu ngoặc kép) để làm tổ bình luận của chúng tôi.

Khi bạn sử dụng các chuỗi đa dòng trong Python mà không gán chuỗi cho một biến, một phần của mã sẽ bị bỏ qua.

Đây là một ví dụ:

"""
When this code runs,
you will see Hello World! 
in the console.
"""
print("Hello World!")

Sự kết luận

Trong bài viết này, chúng tôi đã tìm hiểu lý do tại sao điều quan trọng là nhận xét mã của chúng tôi và cách sử dụng nhận xét. Chúng tôi cũng thấy cách tạo ra các bình luận đa dòng.

Mã hóa hạnh phúc!