Nhận xét mô tả những gì đang xảy ra bên trong một chương trình để một người nhìn vào mã nguồn không gặp khó khăn trong việc tìm ra nó
Trong bài viết này, bạn sẽ học
- Cách thêm nhận xét vào mã Python của bạn
- Sự cần thiết của các ý kiến
- Nhận xét nội tuyến, nhận xét khối và nhận xét nhiều dòng là gì
- Việc sử dụng các bình luận chuỗi doc
Mục lục
Bình luận trong Python là gì?
Các chú thích là những mô tả giúp người lập trình hiểu chức năng của chương trình. Vì vậy, bình luận là cần thiết trong khi viết mã bằng Python
Chú thích trong Python là các dòng trong mã bị trình thông dịch bỏ qua trong quá trình thực thi chương trình. Nhận xét nâng cao khả năng đọc mã và giúp các lập trình viên hiểu mã rất cẩn thận. Có ba loại nhận xét trong Python –
- Nhận xét dòng đơn
- Nhận xét nhiều dòng
- Nhận xét về chuỗi tài liệu
Ví dụ. Bình luận trong Python
Python3
geeksforgeeks5
geeksforgeeks6
geeksforgeeks7____28
geeksforgeeks9
GeeksforGeeks0
GeeksforGeeks1
đầu ra.
geeksforgeeks
Trong ví dụ trên, có thể thấy rằng các chú thích bị trình thông dịch bỏ qua trong quá trình thực thi chương trình
Nhận xét thường được sử dụng cho các mục đích sau.
- Khả năng đọc mã
- Giải thích về mã hoặc Siêu dữ liệu của dự án
- Ngăn chặn thực thi mã
- Để bao gồm các tài nguyên
Các loại bình luận trong Python
Có ba loại bình luận chính trong Python. họ đang.
Nhận xét một dòng
Nhận xét một dòng Python bắt đầu bằng ký hiệu thẻ bắt đầu bằng # [#] không có khoảng trắng và kéo dài đến cuối dòng. Nếu bình luận vượt quá một dòng thì hãy đặt thẻ bắt đầu bằng # ở dòng tiếp theo và tiếp tục bình luận. Nhận xét một dòng của Python được chứng minh là hữu ích để cung cấp các giải thích ngắn cho các biến, khai báo hàm và biểu thức. Xem đoạn mã sau thể hiện nhận xét một dòng.
Ví dụ.
Python3
GeeksforGeeks2
GeeksforGeeks0
GeeksforGeeks4
GeeksforGeeks5
GeeksforGeeks6
Đầu ra
GeeksforGeeks
Nhận xét nhiều dòng
Python không cung cấp tùy chọn cho nhận xét nhiều dòng. Tuy nhiên, có nhiều cách khác nhau để chúng ta có thể viết nhận xét nhiều dòng
Sử dụng nhiều Hashtags [#]
Chúng ta có thể sử dụng nhiều hashtag [#] để viết bình luận nhiều dòng trong Python. Mỗi và mọi dòng sẽ được coi là một nhận xét một dòng
Ví dụ. Bình luận nhiều dòng sử dụng nhiều thẻ bắt đầu bằng # [#]
Python3
GeeksforGeeks7
GeeksforGeeks8
_______00____04____131____06
Đầu ra
GeeksforGeeks3
Sử dụng chuỗi ký tự
Python bỏ qua các chuỗi ký tự không được gán cho một biến để chúng ta có thể sử dụng các chuỗi ký tự này làm nhận xét.
ví dụ 1
Python3
GeeksforGeeks33
Khi thực thi đoạn mã trên, chúng ta có thể thấy rằng sẽ không có bất kỳ đầu ra nào nên chúng ta sử dụng các chuỗi có dấu ngoặc kép [“””] làm nhận xét nhiều dòng
ví dụ 2. Nhận xét nhiều dòng bằng cách sử dụng chuỗi ký tự
Python3
GeeksforGeeks34
________ 135 ________ 136
_______00____04____131____06
Đầu ra
GeeksforGeeks3
Chuỗi tài liệu Python
Chuỗi doc Python là chuỗi ký tự có ba dấu ngoặc kép xuất hiện ngay sau hàm. Nó được sử dụng để liên kết tài liệu đã được viết với các mô-đun, hàm, lớp và phương thức Python. Nó được thêm ngay bên dưới các chức năng, mô-đun hoặc lớp để mô tả những gì chúng làm. Trong Python, chuỗi tài liệu sau đó được cung cấp thông qua thuộc tính __doc__