Thụt lề, ghi chú làm sao cho đoạn code đẹp

Trong hướng dẫn này, bạn sẽ tìm hiểu về các câu lệnh Python, tại sao thụt lề lại quan trọng và việc sử dụng các chú thích trong lập trình.

Tuyên bố Python

Các hướng dẫn mà trình thông dịch Python có thể thực thi được gọi là các câu lệnh. Ví dụ, a = 1là một câu lệnh gán. ifstatement, forstatement, whilestatement, v.v. là các loại câu lệnh khác sẽ được thảo luận ở phần sau.

Câu lệnh nhiều dòng

Trong Python, phần cuối của một câu lệnh được đánh dấu bằng một ký tự dòng mới. Nhưng chúng ta có thể tạo một câu lệnh kéo dài qua nhiều dòng với ký tự tiếp tục dòng (\). Ví dụ:

a = 1 + 2 + 3 + \
    4 + 5 + 6 + \
    7 + 8 + 9

Đây là một dòng tiếp tục rõ ràng. Trong Python, việc tiếp tục dòng được ngụ ý bên trong dấu ngoặc đơn () , dấu ngoặc [] và dấu ngoặc nhọn {} . Ví dụ: chúng ta có thể triển khai câu lệnh nhiều dòng ở trên như:

a = (1 + 2 + 3 +
    4 + 5 + 6 +
    7 + 8 + 9)

Ở đây, các dấu ngoặc đơn bao quanh () ngầm định tiếp tục dòng. Tương tự là trường hợp với [] và {} . Ví dụ:

colors = ['red',
          'blue',
          'green']

Chúng ta cũng có thể đặt nhiều câu lệnh trong một dòng bằng cách sử dụng dấu chấm phẩy, như sau:

a = 1; b = 2; c = 3

Thụt lề Python

Hầu hết các ngôn ngữ lập trình như C, C ++ và Java sử dụng dấu ngoặc nhọn {} để xác định một khối mã. Python, tuy nhiên, sử dụng thụt lề.

Một khối mã (nội dung của một hàm , vòng lặp , v.v.) bắt đầu bằng thụt đầu dòng và kết thúc bằng dòng không có dấu đầu tiên. Số lượng thụt lề là tùy thuộc vào bạn, nhưng nó phải nhất quán trong toàn bộ khối đó.

Nói chung, bốn khoảng trắng được sử dụng để thụt lề và được ưu tiên hơn các tab. Đây là một ví dụ.

for i in range(1,11):
    print(i)
    if i == 5:
        break

Việc thực thi thụt lề trong Python làm cho mã trông gọn gàng và sạch sẽ. Điều này dẫn đến các chương trình Python trông giống nhau và nhất quán.

Thụt lề có thể bị bỏ qua khi tiếp tục dòng, nhưng bạn luôn nên thụt lề. Nó làm cho mã dễ đọc hơn. Ví dụ:

if True:
    print('Hello')
    a = 5

if True: print('Hello'); a = 5

cả hai đều hợp lệ và làm điều tương tự, nhưng kiểu cũ rõ ràng hơn.

Thụt lề không chính xác sẽ dẫn đến IndentationError.

Nhận xét Python

Nhận xét là rất quan trọng trong khi viết một chương trình. Chúng mô tả những gì đang diễn ra bên trong một chương trình, để người xem mã nguồn không gặp khó khăn khi tìm ra nó.

Bạn có thể quên các chi tiết chính của chương trình bạn vừa viết trong thời gian một tháng. Vì vậy, dành thời gian để giải thích những khái niệm này dưới dạng nhận xét luôn luôn có hiệu quả.

Trong Python, chúng tôi sử dụng ký hiệu băm ( # ) để bắt đầu viết nhận xét.

Nó mở rộng đến ký tự dòng mới. Nhận xét là để người lập trình hiểu rõ hơn về một chương trình. Trình thông dịch Python bỏ qua nhận xét.

#This is a comment
#print out Hello
print('Hello')

Nhận xét nhiều dòng

Chúng tôi có thể có những nhận xét kéo dài đến nhiều dòng. Một cách là sử dụng ký hiệu băm ( # ) ở đầu mỗi dòng. Ví dụ:

#This is a long comment
#and it extends
#to multiple lines

Một cách khác để làm điều này là sử dụng dấu ngoặc kép, ” ‘ hoặc “” ” .

Những dấu ngoặc kép này thường được sử dụng cho các chuỗi nhiều dòng. Nhưng chúng cũng có thể được sử dụng như một bình luận nhiều dòng. Trừ khi chúng không phải là docstrings, chúng không tạo ra bất kỳ mã bổ sung nào.

"""This is also a
perfect example of
multi-line comments"""

Để tìm hiểu thêm về nhận xét, hãy truy cập Nhận xét Python .

Docstrings bằng Python

Docstring là viết tắt của chuỗi tài liệu.

Python docstrings (chuỗi tài liệu) là các chuỗi ký tự xuất hiện ngay sau định nghĩa của một hàm, phương thức, lớp hoặc mô-đun.

Dấu ngoặc kép được sử dụng trong khi viết docstrings. Ví dụ:

def double(num):
    """Function to double the value"""
    return 2*num

Các chuỗi tài liệu xuất hiện ngay sau định nghĩa của một hàm, lớp hoặc một mô-đun. Điều này tách các chuỗi doc từ các nhận xét nhiều dòng bằng cách sử dụng dấu ngoặc kép.

Các docstrings được liên kết với đối tượng làm __doc__thuộc tính của chúng .

Vì vậy, chúng ta có thể truy cập docstrings của hàm trên bằng các dòng mã sau:

def double(num):
    """Function to double the value"""
    return 2*num
print(double.__doc__)

Đầu ra

Function to double the value








Gõ tìm kiếm nhanh...