Các comments chương trình và docstrings Python

Phần phụ này trên các strings kết luận một cuộc thảo luận về các comments chương trình (đôi khi cũng được gọi là
các block comments trong các ngôn ngữ lập trình khác). Một comment là một đoạn text chương trình cái máy tính sẽ
bỏ qua nhưng cái đó cung cấp tài liệu hướng dẫn hữu ích cho các lập trình viên. Tại tối thiểu, tác giả của một
chương trình có thể bao gồm tên của họ và phát biểu ngắn về mục đích chương trình tại phần bắt đầu của file chương
trình. Dạng comment này gọi là docstring, là string nhiều dòng của hình thức thảo luận trước kia trong phần này. Sau
đây là một docstring cái bắt đầu một chương trình điển hình cho phiên làm việc lab:

“””
Program: circle.py
Author: Ken Lambert
Last date modified: 10/10/22
The purpose of this program is to compute the area of a circle. The input is an
integer or floating-point number representing the radius of the circle. The output
is a floating-point number labeled as the area of the circle.
“””

Ngoài các docstrings, các comments kết thúc dòng có thể tài liệu hóa một chương trình. Các comments này bắt đầu với
kí hiệu # và mở rộng tới cuối của một dòng. Một comment kết thúc dòng có thể giải thích mục đích của một biến hay
chiến lược sử dụng bởi một đoạn code, nếu nó chưa rõ ràng. Sau đây là một ví dụ:

>>> RATE = 0.70 # Conversion rate for Canadian to US dollars

Xuyên suốt các học phần, các docstrings xuất hiện trong màu xanh lá cây và các comments kết thúc dòng xuất hiện
trong màu đỏ.

Chia sẻ