Nhận xét trong Python là gì cho một ví dụ?
Trong hướng dẫn Nhận xét và chuỗi tài liệu trong python này, chúng ta sẽ tìm hiểu những điều cơ bản về Nhận xét và Chuỗi tài liệu, đồng thời tìm hiểu sâu hơn về các khái niệm và định dạng chính cho Nhận xét và Tài liệu
Tác giả. Sahil (Bạn cũng có thể viết bài trên thatascience. Liên hệ chúng tôi) Show
Sửa đổi lần cuối. 2 Tháng một, 2022 Bình luận trong Python là gì?Đầu tiên trong Hướng dẫn về Nhận xét và Tài liệu, chúng ta sẽ nói về Nhận xét vì chúng phổ biến hơn và dễ hiểu hơn
Tại sao chúng ta sử dụng Bình luận?
(Bán tại. [X=10 #Điều này gán giá trị 10 cho biến X chỉ tỷ lệ phần trăm lỗi. ] Nhận xét cung cấp ngữ cảnh và tránh nhầm lẫn. )
(Bán tại. [A=20 B=30 #C=40], Giả sử vì lý do nào đó chúng ta muốn gán một giá trị cho C ngay bây giờ, Sau đó, bằng cách sử dụng nhận xét, chúng tôi có thể tắt dòng cụ thể đó Làm cách nào để tạo nhận xét trong Python?
Tài liệu trong Python là gì?Các tài liệu Python là các chuỗi ký tự xuất hiện ngay sau định nghĩa của hàm, phương thức, lớp hoặc mô-đun
Tại sao chúng ta sử dụng Docstrings?Tài liệu giúp bạn hiểu khả năng của một mô-đun hoặc chức năng Ví dụ: giả sử bạn đã cài đặt thư viện gấu trúc và bạn muốn biết tất cả về pandas packages. Bạn chỉ cần sử dụng chức năng trợ giúp để lấy tất cả thông tin. [Bán tại. (trợ giúp(gấu trúc))]
Chúng tôi sử dụng Docstrings như thế nào?
(Bán tại. [thêm chắc chắn (a, b) ‘’’Thực hiện cộng các biến đầu vào đã cho Thông số. int, int (hai số lấy từ người dùng để cộng) trả lại. int (kết quả là phép cộng của hai số)‘’’ c = a + b trở lại c])
print(value, …, sep=’ ‘, end=’\n’, file=sys. thiết bị xuất chuẩn, flush=False)In giá trị vào luồng hoặc tới hệ thống. thiết bị xuất chuẩn theo mặc định Đối số từ khóa tùy chọn. tập tin. một đối tượng giống như tệp (luồng); . tiêu chuẩn. tháng chín. chuỗi được chèn giữa các giá trị, mặc định là khoảng trắng kết thúc. chuỗi được nối sau giá trị cuối cùng, mặc định một dòng mới tuôn ra. có nên buộc xả luồng không Sự khác biệt giữa Comments và Docstrings trong Python
Nhận xét đơn và nhiều dòng
Làm thế nào để viết bình luận tốt bằng Python?
Tài liệu đơn và nhiều dòng
Các loại Docstring khác nhau
Các định dạng khác nhau của Docstrings
1. định dạng nhân sư
[Ví dụ về định dạng Nhân sư]
Bây giờ chúng ta đã hiểu hoạt động của Định dạng chuỗi tài liệu Sphinx, Mọi định dạng khác chỉ là một phiên bản tương tự hoặc có nguồn gốc từ định dạng Nhân sư làm cho các định dạng sau dễ hiểu hơn nhiều class Bank(object): ''' The Bank object contains info about all the accounts :param arg: The arg is used for ... :type arg: str :param `*args`: The variable arguments are used for ... :param `**kwargs`: The keyword arguments are used for ... :ivar arg: This is where we store arg :vartype arg: str ''' def __init__(self, arg, *args, **kwargs): self.arg = arg def acc(self, Money_withdrawn, Total_Money): '''We can't Withdraw Money without it being in the bank :param Money_withdrawn: The amount of money withdrawn :type amount: float :param Total_Money: Total Money in the account :type amount: float :raises: :class:`RuntimeError`: Amount Withdrawn greater than Total_Money :returns: Remaining Money :rtype: float ''' pass 2. Google Tài liệu
class Bank(object): ''' The Bank object contains info about all the accounts Args: arg (str): The arg is used for... *args: The variable arguments are used for... **kwargs: The keyword arguments are used for... Attributes: arg (str): This is where we store arg, ''' def __init__(self, arg, *args, **kwargs): self.arg = arg def acc(self, Money_withdrawn, Total_Money): '''We can't Withdraw Money without it being in the bank Args: Money_withdrawn (float): The amount of Money Withdrawn Total_money (float): Total Money in the account Raises: RuntimeError: Amount Withdrawn greater than Total_Money Returns: float: Remaining Money ''' pass 3. Kiểu dáng gọn gàng
[Ví dụ về định dạng NumPy] class Bank(object): ''' The Bank object contains info about all the accounts Parameters ---------- arg : str The arg is used for ... *args The variable arguments are used for ... **kwargs The keyword arguments are used for ... Attributes ---------- arg : str This is where we store arg, ''' def __init__(self, arg, *args, **kwargs): self.arg = arg def acc(self, Money_withdrawn, Total_Money): '''We can't Withdraw Money without it being in the bank Parameters ---------- Money_withdrawn : float The amount of money withdrawn Total_Money : float Total Money in the account Raises ------ RuntimeError Amount Withdrawn greater than Total_Money Returns ------- float Remaining Money ''' pass Kết luận về Nhận xét và Chuỗi tài liệu trong Hướng dẫn Python
|