Python Comments - thanhleva

Chúng ta sẽ nghiên cứu cách viết comment trong chương trình của chúng ta trong bài viết này. Chúng ta cũng sẽ tìm hiểu về nhận xét một dòng, nhận xét nhiều dòng, chuỗi tài liệu và các nhận xét Python khác.

Giới thiệu về Python Comments

Muốn mô tả đoạn mã chúng tôi phát triển. Chẳng hạn, chúng ta có thể muốn ghi chú lý do tại sao một phần của tập lệnh lại hoạt động. Chúng tôi tận dụng các nhận xét để thực hiện điều này. Các công thức, thủ tục và logic nghiệp vụ phức tạp thường được giải thích bằng các nhận xét. Trình thông dịch Python bỏ qua các nhận xét và chỉ diễn giải tập lệnh khi chạy chương trình. Nhận xét một dòng, nhận xét nhiều dòng và chuỗi tài liệu là 3 loại nhận xét trong Python.

Ưu điểm của việc sử dụng comment

Code trở nên dễ hiểu hơn, khi chúng tôi sử dụng các comment trong đó. Nó hỗ trợ chúng ta nhớ lại lý do tại sao các đoạn mã cụ thể được tạo ra, và làm cho chương trình trở nên dễ hiểu hơn.

Ngoài ra, chúng ta có thể tận dụng các comment để bỏ qua đoạn mã cụ thể trong khi đánh giá chương trình. Kỹ thuật đơn giản này ngăn một số dòng chạy hoặc tạo mã giả lập nhanh cho chương trình.

Dưới đây là một số cách sử dụng phổ biến nhất cho comment:

Khả năng đọc hiểu của mã nguồn
Hạn chế thực thi mã
Cung cấp cái nhìn tổng quan về chương trình hoặc dự án
Để thêm cập nhật, nâng cấp logic vào mã nguồn

Các loại Comment trong Python

Trong Python, có 3 loại comment. Chúng được mô tả dưới đây:

Comment 1 dòng

Comment một dòng trong Python đã được chứng minh là có hiệu quả trong việc cung cấp các mô tả nhanh cho các tham số, định nghĩa hàm và biểu thức. Comment một dòng của Python có hashtag # ở đầu và tiếp tục cho đến hết dòng. Nếu comment tiếp tục ở dòng tiếp theo, hãy thêm thẻ bắt đầu bằng # vào dòng tiếp theo và tiếp tục phần nhận xét/mô tả cho đoạn mã. Hãy xem xét đoạn mã đi kèm, cho thấy cách sử dụng comment một dòng:

Code

    # This code is to show an example of a single-line comment  
    print( 'This statement does not have a hashtag before it' )

Output:

This statement does not have a hashtag before it

Sau đây là Comment:

   # This code is to show an example of a single-line comment

Trình biên dịch Python bỏ qua dòng này.

Mọi thứ theo sau # đều bị bỏ qua. Do đó, chúng ta có thể đặt chương trình được đề cập ở trên trong một dòng như sau:

Code

    print( 'This is not a comment' ) # this code is to show an example of a single-line comment

Output:

This is not a comment

Đầu ra của chương trình này sẽ giống với ví dụ trên. Trình biên dịch bỏ qua tất cả nội dung sau #.

Comment nhiều dòng

Python không cung cấp khả năng comment nhiều dòng. Tuy nhiên, thực sự có rất nhiều cách để tạo bình luận nhiều dòng.

Với nhiều Hashtags (#)

Trong Python, chúng ta có thể sử dụng hashtag (#) nhiều lần để tạo nhiều dòng comment. Mỗi dòng có dấu (#) trước nó sẽ được coi là comment một dòng.

Code

    # it is a  
    # comment  
    # extending to multiple lines

Trong trường hợp này, mỗi dòng được coi là một comment và tất cả chúng đều bị bỏ qua.

Dùng String Literals

Vì Python bỏ qua các biểu thức chuỗi không được phân bổ cho một biến nên chúng ta có thể sử dụng chúng làm nhận xét.

Code

    'it is a comment extending to multiple lines'

Chúng ta có thể quan sát thấy rằng khi chạy mã này, sẽ không có kết quả đầu ra; do đó, chúng tôi sử dụng các chuỗi bên trong dấu ngoặc kép (“””) làm nhận xét nhiều dòng.

Chuỗi tài liệu Python (Python Docstring)

Các chuỗi được đặt trong dấu ngoặc kép xuất hiện ngay sau hàm được xác định được gọi là chuỗi tài liệu Python. Nó được thiết kế để liên kết tài liệu được phát triển cho các mô-đun, phương thức, lớp và hàm Python với nhau. Nó được đặt ngay bên dưới hàm, mô-đun hoặc lớp để giải thích chức năng của chúng. Sau đó, chuỗi tài liệu có thể được truy cập dễ dàng bằng thuộc tính __doc__.

Code

    # Code to show how we use docstrings in Python  
      
    def add(x, y):  
        """This function adds the values of x and y"""  
        return x + y  
       
    # Displaying the docstring of the add function  
    print( add.__doc__ )

Output:

This function adds the values of x and y