Chuỗi tài liệu Python [hoặc docstrings] tạo điều kiện liên kết tài liệu với các mô-đun, hàm, lớp và phương thức Python. Docstring của một đối tượng được định nghĩa bằng cách bao gồm một hằng chuỗi làm câu lệnh đầu tiên trong định nghĩa của đối tượng. Nó được chỉ định trong mã nguồn, được sử dụng, giống như một nhận xét, để ghi lại một đoạn mã cụ thể.
Nội dung chính ShowShow
- Cấu trúc của Docstring trong Python
- Ví dụ về Docstring:
- Cách sử dụng Docstrings trong Python
- Khai báo Docstrings trong Python
- Truy cập Docstrings
- Ví dụ: Sử dụng dấu ngoặc kép:
- Ví dụ: Sử dụng dấu ngoặc ba
- Thụt lề trong Docstrings
- Docstring một dòng trong Python
- Docstring nhiều dòng trong Python
- Sự khác biệt giữa nhận xét Python và docstrings
Không giống như các bình luận mã nguồn thông thường, docstring phải mô tả chức năng hoạt động chứ không phải như thế nào. Tất cả các hàm phải có một Docstring, Điều này cho phép chương trình kiểm tra các nhận xét này tại thời điểm chạy, ví dụ như một hệ thống trợ giúp tương tác hoặc dưới dạng siêu dữ liệu.
>>> Xem thêm: Không gian tên trong Python- Tìm hiểu về không gian tên trong PythonKhông gian tên trong Python- Tìm hiểu về không gian tên trong Python
Ví dụ về Docstring trong Python
Cấu trúc của Docstring trong Python
Ví dụ về Docstring:
Cách sử dụng Docstrings trong Python
Khai báo Docstrings trong Python
Truy cập Docstrings
Ví dụ về Docstring:
Cách sử dụng Docstrings trong Python
Khai báo Docstrings trong Python
Truy cập Docstrings
Cách sử dụng Docstrings trong Python
Khai báo Docstrings trong Python
Truy cập Docstrings
Truy cập Docstrings
Ví dụ: Sử dụng dấu ngoặc kép:
Ví dụ: Sử dụng dấu ngoặc ba
Ví dụ: Sử dụng dấu ngoặc kép:
Ví dụ: Sử dụng dấu ngoặc ba
Thụt lề trong Docstrings
Docstring một dòng trong Python
Docstring nhiều dòng trong Python
Sự khác biệt giữa nhận xét Python và docstrings
print[my_function.__doc__]
Không giống như các bình luận mã nguồn thông thường, docstring phải mô tả chức năng hoạt động chứ không phải như thế nào. Tất cả các hàm phải có một Docstring, Điều này cho phép chương trình kiểm tra các nhận xét này tại thời điểm chạy, ví dụ như một hệ thống trợ giúp tương tác hoặc dưới dạng siêu dữ liệu.
help[my_function]
>>> Xem thêm: Không gian tên trong Python- Tìm hiểu về không gian tên trong Python
Ví dụ về Docstring trong Python
- Dòng chuỗi doc phải bắt đầu bằng chữ hoa và kết thúc bằng dấu chấm.
- Dòng đầu tiên nên là một mô tả ngắn.
- Nếu có nhiều dòng hơn trong docstring, dòng thứ hai phải để trống, ngăn cách trực quan phần tóm tắt với phần còn lại của mô tả.
- Các dòng sau nên là một hoặc nhiều đoạn văn mô tả các quy ước gọi của đối tượng, các tác dụng phụ của nó,...
my_function[]
def square[n]:
- Dòng đầu tiên nên là một mô tả ngắn.
Ví dụ: Sử dụng dấu ngoặc ba
Thụt lề trong Docstrings
Docstring một dòng trong Python
Docstring nhiều dòng trong Python
Sự khác biệt giữa nhận xét Python và docstrings
Không giống như các bình luận mã nguồn thông thường, docstring phải mô tả chức năng hoạt động chứ không phải như thế nào. Tất cả các hàm phải có một Docstring, Điều này cho phép chương trình kiểm tra các nhận xét này tại thời điểm chạy, ví dụ như một hệ thống trợ giúp tương tác hoặc dưới dạng siêu dữ liệu.
print[my_function.__doc__]
>>> Xem thêm: Không gian tên trong Python- Tìm hiểu về không gian tên trong Python
help[my_function]
Output:
Ví dụ về Docstring trong Python
- Dòng chuỗi doc phải bắt đầu bằng chữ hoa và kết thúc bằng dấu chấm.
- Dòng đầu tiên nên là một mô tả ngắn.
- Nếu có nhiều dòng hơn trong docstring, dòng thứ hai phải để trống, ngăn cách trực quan phần tóm tắt với phần còn lại của mô tả.
- Các dòng sau nên là một hoặc nhiều đoạn văn mô tả các quy ước gọi của đối tượng, các tác dụng phụ của nó,...
my_function[]
def square[n]:
- Dòng đầu tiên nên là một mô tả ngắn.
- Nếu có nhiều dòng hơn trong docstring, dòng thứ hai phải để trống, ngăn cách trực quan phần tóm tắt với phần còn lại của mô tả. Khóa học lập trình Python
Thụt lề trong Docstrings
Docstring một dòng trong Python
Docstring một dòng trong Python
Docstring nhiều dòng trong Python
Sự khác biệt giữa nhận xét Python và docstrings
Không giống như các bình luận mã nguồn thông thường, docstring phải mô tả chức năng hoạt động chứ không phải như thế nào. Tất cả các hàm phải có một Docstring, Điều này cho phép chương trình kiểm tra các nhận xét này tại thời điểm chạy, ví dụ như một hệ thống trợ giúp tương tác hoặc dưới dạng siêu dữ liệu.
>>> Xem thêm: Không gian tên trong Python- Tìm hiểu về không gian tên trong Python
print[power.__doc__]
Ví dụ về Docstring trong Python
- Dòng chuỗi doc phải bắt đầu bằng chữ hoa và kết thúc bằng dấu chấm.
Docstring nhiều dòng trong Python
Sự khác biệt giữa nhận xét Python và docstrings
Không giống như các bình luận mã nguồn thông thường, docstring phải mô tả chức năng hoạt động chứ không phải như thế nào. Tất cả các hàm phải có một Docstring, Điều này cho phép chương trình kiểm tra các nhận xét này tại thời điểm chạy, ví dụ như một hệ thống trợ giúp tương tác hoặc dưới dạng siêu dữ liệu.
def my_function[arg1]:
"""
Summary line.
Extended description of function.
Parameters:
arg1 [int]: Description of arg1
Returns:
int: Description of return value
"""
return arg1
print[my_function.__doc__]
Sự khác biệt giữa nhận xét Python và docstrings
Bình luận Python là thông tin hữu ích mà nhà phát triển cung cấp để làm cho người đọc hiểu mã nguồn. Nó giải thích logic hoặc một phần của nó được sử dụng trong mã. Nó được viết bằng cách sử dụng ký hiệu #.
Trong khi Docstrings trong Python cung cấp một cách thuận tiện để liên kết tài liệu với các mô-đun, hàm, lớp và phương thức Python.
Kết luận: Docstring là một thành phần cần thiết cho quá trình lập trình trong Python. Bài viết trên đã giúp bạn tìm hiểu về Docstring, các khái niệm và cách sử dụng Docstring trong Python. Muốn thành thạo Python và các ngôn ngữ lập trình khác, tìm hiểu ngay các khóa học lập trình tại T3H bạn nhé.Docstring là một thành phần cần thiết cho quá trình lập trình trong Python. Bài viết trên đã giúp bạn tìm hiểu về Docstring, các khái niệm và cách sử dụng Docstring trong Python. Muốn thành thạo Python và các ngôn ngữ lập trình khác, tìm hiểu ngay các khóa học lập trình tại T3H bạn nhé.
Nguồn: Geeksforgeeks, programiz