Cách viết bình luận trong python

Nhận xét trong Python được sử dụng để làm gì?

Nhận xét trong Python được xác định bằng ký hiệu băm, # và kéo dài đến cuối dòng. Tuy nhiên, các ký tự băm trong một chuỗi không được coi là nhận xét. Có ba cách để viết nhận xét - dưới dạng một dòng riêng biệt, bên cạnh câu lệnh mã tương ứng hoặc dưới dạng khối nhận xét nhiều dòng

Có nhiều cách sử dụng để viết bình luận trong Python. Một số sử dụng quan trọng bao gồm

• Tăng khả năng đọc
• Giải thích mã cho người khác
• Hiểu mã dễ dàng sau một thời gian dài
• Bao gồm tài nguyên
• Sử dụng lại mã hiện có

Ưu điểm của việc sử dụng Nhận xét trong Python là gì?

Nhận xét trong Python cung cấp nhiều lợi thế. lợi ích chính của họ bao gồm

• Làm cho mã dễ hiểu bởi các lập trình viên khác
• Mã trở nên tự giải thích
• Giúp ghi nhớ lý do tại sao chúng tôi sử dụng một lệnh, phương pháp hoặc chức năng cụ thể trong mã
• Cho phép trình thông dịch bỏ qua một số phần của mã trong khi kiểm tra

Khóa đào tạo Python

Các loại bình luận khác nhau trong Python là gì?

Có ba loại bình luận. nhận xét một dòng, nhiều dòng và chuỗi tài liệu. Cú pháp của các bình luận khác nhau tùy thuộc vào loại. Hướng dẫn này sẽ khám phá từng loại nhận xét riêng lẻ, cùng với các ví dụ

Nhận xét một dòng

Nhận xét một dòng bắt đầu bằng ký tự “#”. Bất cứ điều gì được viết trong một dòng sau '#' đều được coi là nhận xét. Cú pháp để viết bình luận một dòng là

# bình luận ở đây

Có hai cách sử dụng comment một dòng trong Python. Bạn có thể sử dụng nó trước mã hoặc bên cạnh mã. Ví dụ được mô tả bên dưới cho thấy việc sử dụng nhận xét theo cả hai cách

PEP8, Python Style Guide, khuyến nghị sử dụng ít hơn 79 ký tự trong nhận xét một dòng để dễ đọc hơn. Nếu nhận xét của bạn vượt quá độ dài được đề xuất, bạn có thể sử dụng loại tiếp theo. nhận xét nhiều dòng

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

Python không hỗ trợ bình luận nhiều dòng. Tuy nhiên, có nhiều cách để khắc phục vấn đề này. Không có cách nào trong số này là nhận xét nhiều dòng về mặt kỹ thuật, nhưng bạn có thể sử dụng chúng như một. Cách thứ nhất là sử dụng dấu # ở đầu mỗi dòng bình luận

Cách tiếp theo là sử dụng các chuỗi ký tự nhưng không gán chúng cho bất kỳ biến nào. Nếu bạn không gán một chuỗi ký tự cho một biến, trình thông dịch Python sẽ bỏ qua nó. Sử dụng lợi thế này để viết nhận xét nhiều dòng. Bạn có thể sử dụng trích dẫn đơn [‘’] hoặc trích dẫn kép [“”]

Bạn cũng có thể sử dụng chuỗi nhiều dòng để bình luận. Để thực hiện việc này, hãy sử dụng dấu ngoặc kép ‘’ hoặc “” ba lần

Tài liệu Python

Python cung cấp một tính năng có sẵn được gọi là docstrings để nhận xét về các mô-đun, phương thức, hàm, đối tượng và lớp. Chúng được viết ở dòng đầu tiên sau khi xác định mô-đun, chức năng, phương thức, v.v. , sử dụng ba dấu ngoặc kép [‘’ hoặc “”]. Nếu bạn không sử dụng nó ở dòng đầu tiên, trình thông dịch sẽ không lấy nó làm chuỗi tài liệu. Bạn cũng có thể truy cập các chuỗi tài liệu bằng thuộc tính __doc__

Khoa học dữ liệu MIỄN PHÍ với khóa học Python

Làm thế nào để Viết Nhận xét Tốt bằng Python?

Bình luận là một phần quan trọng của một chương trình. Do đó, điều cần thiết là học cách viết bình luận tốt. Dưới đây là một số đặc điểm xác định nhận xét tốt

• Đảm bảo rằng chúng ngắn gọn
• Đừng viết bình luận chung chung;

[a=10 #gán 10 cho a, tránh viết những nhận xét chung chung như vậy]

• Viết nhận xét mô tả nhiệm vụ tổng thể của một chức năng hoặc phương thức chứ không phải chi tiết cụ thể
• Nhận xét tốt là tự giải thích
• Đừng viết bình luận dư thừa

Mong muốn chuyển sang lĩnh vực lập trình?

Sự kết luận

Như vậy, chúng ta đã đi đến phần cuối của hướng dẫn 'Nhận xét trong Python'. Viết nhận xét tốt bằng Python sẽ cho phép các lập trình viên khác đọc và hiểu mã của bạn một cách dễ dàng. Đây là một trong nhiều khái niệm cơ bản trong Python mà bạn phải học để nắm bắt ngôn ngữ lập trình. Với danh sách phát hướng dẫn Python dành cho người mới bắt đầu của chúng tôi, bạn có thể dễ dàng tìm hiểu mọi thứ về nhận xét và các khái niệm khác trong Python

Có bất kỳ câu hỏi cho chúng tôi?