Cách viết bình luận khác nhau trong Python là gì?
Tóm lược. trong hướng dẫn này, bạn sẽ học cách thêm nhận xét vào mã của mình. Và bạn sẽ tìm hiểu các loại nhận xét Python khác nhau bao gồm nhận xét khối, nhận xét nội tuyến và chuỗi tài liệu Show
Giới thiệu về bình luận PythonĐôi khi, bạn muốn ghi lại mã mà bạn viết. Ví dụ: bạn có thể muốn lưu ý lý do tại sao một đoạn mã hoạt động. Để làm điều đó, bạn sử dụng các ý kiến Thông thường, bạn sử dụng nhận xét để giải thích các công thức, thuật toán và logic kinh doanh phức tạp Khi thực thi một chương trình, trình thông dịch Python sẽ bỏ qua các chú thích và chỉ diễn giải mã Python cung cấp ba loại nhận xét bao gồm nhận xét khối, nhận xét nội tuyến và chuỗi tài liệu Bình luận khối PythonMột bình luận khối giải thích mã theo sau nó. Thông thường, bạn thụt lề một khối nhận xét ở cùng cấp với khối mã Để tạo một bình luận khối, bạn bắt đầu với một dấu thăng đơn (_______8_______), theo sau là một khoảng trắng và một chuỗi văn bản. Ví dụ
Nhận xét nội tuyến PythonKhi bạn đặt một nhận xét trên cùng một dòng với một câu lệnh, bạn sẽ có một nhận xét nội tuyến Tương tự như một bình luận khối, một bình luận nội tuyến bắt đầu bằng một dấu thăng duy nhất ( Ví dụ sau minh họa một nhận xét nội tuyến
tài liệu PythonChuỗi tài liệu là một chuỗi ký tự mà bạn đặt làm dòng đầu tiên trong một khối mã, ví dụ: một hàm Không giống như một nhận xét thông thường, một chuỗi tài liệu có thể được truy cập trong thời gian chạy bằng cách sử dụng thuộc tính Thông thường, bạn sử dụng chuỗi tài liệu để tự động tạo tài liệu mã Chuỗi tài liệu được gọi là docstrings Về mặt kỹ thuật, docstrings không phải là ý kiến. Họ tạo các biến ẩn danh tham chiếu các chuỗi. Ngoài ra, chúng không bị trình thông dịch Python bỏ qua Python cung cấp hai loại docstrings. tài liệu một dòng và tài liệu nhiều dòng 1) Tài liệu một dòngĐúng như tên gọi của nó, một chuỗi tài liệu một dòng phù hợp với một dòng. Chuỗi tài liệu một dòng bắt đầu bằng ba dấu ngoặc kép (_______12_______) và cũng kết thúc bằng ba dấu ngoặc kép (_______12_______). Ngoài ra, sẽ không có bất kỳ dòng trống nào trước hoặc sau chuỗi tài liệu một dòng Ví dụ sau minh họa một chuỗi tài liệu một dòng trong hàm 0
2) Tài liệu nhiều dòngKhông giống như chuỗi tài liệu một dòng, chuỗi tài liệu nhiều dòng có thể trải rộng trên nhiều dòng. Một chuỗi tài liệu nhiều dòng cũng bắt đầu bằng ba dấu ngoặc kép (_______12_______) và kết thúc bằng ba dấu ngoặc kép (_______12_______) Ví dụ sau đây cho bạn thấy cách sử dụng chuỗi tài liệu nhiều dòng
Nhận xét nhiều dòng PythonPython không hỗ trợ bình luận nhiều dòng Tuy nhiên, bạn có thể sử dụng chuỗi tài liệu nhiều dòng làm nhận xét nhiều dòng. Guido van Rossum, người tạo ra Python, cũng khuyến nghị điều này Đó là một thực hành tốt để giữ cho nhận xét của bạn rõ ràng, ngắn gọn và giải thích. Mục tiêu cuối cùng là tiết kiệm thời gian và năng lượng cho bạn và những nhà phát triển khác, những người sẽ làm việc với mã sau này 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ệuTác giả. Sahil (Bạn cũng có thể viết bài trên thatascience. Liên hệ chúng tôi) 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
|