Chuỗi tài liệu
Bài học 8 trên 28 trong khóa học Clean Code: viết code tốt hơn với Python của Coddy.
Chuỗi tài liệu (docstring) thường xuất hiện dưới dạng câu lệnh đầu tiên trong phần định nghĩa module, hàm, lớp hoặc phương thức.
Khai báo docstring bằng cách đặt chuỗi trong """ hoặc ''', ví dụ:
def complex(real=0.0, imag=0.0):
"""
Tạo một số phức.
Parameters:
real (float): phần thực (mặc định 0.0)
imag (float): phần ảo (mặc định 0.0)
"""
if imag == 0.0 and real == 0.0:
return complex_zero
...Hãy xem cách đoạn này ghi tài liệu cho hàm complex(real, imag).
Chú ý phần thụt lề của nội dung docstring và
"""
Sau khi dùng docstring như thế này, bạn có thể dùng thuộc tính __doc__ để lấy tài liệu:
complex.__doc__Kết quả sẽ là:
Form a complex number.
Parameters:
real (float) -- the real part (default 0.0)
imag (float) -- the imaginary part (default 0.0)
Thử thách
DễBạn được cung cấp một hàm (function) có chú thích khối (block comment) thay vì docstring.
Nhiệm vụ của bạn là thay chú thích đó bằng docstring hợp lệ. Hãy kiểm tra test case để định dạng docstring chính xác!
Tự làm thử
def sum_binary(a, b):
# Calculate sum of two integers in binary formmated string
# Parameters:
# a (int) -- Integer number
# b (int) -- Another integer number
# Returns:
# binary_sum (str) -- The sum of a and b in binary format
sum = a + b
binary_sum = bin(sum)
return str(binary_sum)[1:] # Final formmating
print(sum_binary.__doc__)Tất cả bài học trong Clean Code: viết code tốt hơn với Python
Tự luyện tập: Trình biên dịch Python online