Chú thích trong python | Laptrinhcanban.com

Chú thích trong python

Hướng dẫn cách chú thích trong python, hay còn gọi là cách comment trong python hoặc là ghi chú trong python. Bạn sẽ học được cách sử dụng dấu than # để chú thích trong python , cách chú thích nhiều dòng trong python cũng như các cách ứng dụng chú thích trong python sau bài học này.

Chú thích trong python là gì

Chú thích trong python là các dòng code được bỏ qua khi chạy chương trình python, nhằm giúp bạn lưu lại các thông tin cần thiết như ngày giờ viết chương trình, tên người viết, mục tiêu viết, giải thích các mục con trong chương trình python v.v..

Các thông tin cần thiết được lưu giữ bởi chú thích trong python sẽ giúp bạn bảo trì chương trình dễ hơn, cũng như dễ chuyển giao lại dự án cho người khác hoặc là chia sẽ dự án cho nhiều người cùng làm.

Sử dụng dấu than # để chú thích trong python

Để viết chú thích trong python, chúng ta viết chú thích bắt đầu bởi dấu than # với cú pháp sau đây:

#chú thích

Trong đó chú thích là nội dung chú thích được ghi sau dấu #.

Chú thích trong python sẽ được tính từ đằng sau dấu # cho tới cuối dòng . Chúng ta có thể chú thích vào đầu hay giữa hay bất kỳ vị trí nào trong câu lệnh cũng được, giống như ví dụ sau đây:

##
# khởi tạo : 2021-01-08
# tác giả :Kiyoshi
##

age = 30 # tạo biến tuổi

#in tuổi ra màn hình
print(age)

Lưu ý rằng chúng ta không thể chú thích trong python nếu trong câu lệnh đó được xuống dòng và viết trên nhiều dòng như ví dụ dưới đây:

num = 1 + 2 + 3 + 4 \ #Chúng ta không thể comment ở vị trí này.
5 + 6
print (num)

Lỗi SyntaxError sẽ xuất hiện như sau:

  File "Main.py", line 1
num = 1 + 2 + 3 + 4 \ #Chúng ta không thể comment ở vị trí này.
^
SyntaxError: unexpected character after line continuation character
  • Về cách xuống dòng trong câu lệnh và viết câu lệnh đó trên nhiều dòng, bạn có thể tham khảo bài viết Xuống dòng trong python

Chú thích nhiều dòng trong python

Để chú thích nhiều dòng trong python, chúng ta viết các dòng chú thích vào giữa ba dấu nháy đơn ''' hoặc ba dấu nháy kép """ với cú pháp sau đây:

"""
dòng chú thích 1
dòng chú thích 2

"""

Hoặc

'''
dòng chú thích 1
dòng chú thích 2

'''

Bản chất của cách viết này là chúng ta khai báo chuỗi nhiều dòng trong python và không thêm lệnh xử lý gì với chuỗi mới khai báo.
Do đó chuỗi nhiều dòng vừa tạo ra sẽ chỉ có tác dụng lưu trữ thông tin mà không ảnh hưởng gì đến kết quả xử lý chương trình.

Chúng ta sử dụng dấu nháy tam này để chú thích trên nhiều dòng trong python như ví dụ sau đây:

"""
Ngày viết : 210121
Tác giả : Kiyoshi
"""

print("chú thích trong python")

Bạn có thể thấy cách chú thích này thường được sử dụng rất nhiều trong các tài liệu trên Gihub, hoặc trong các chương trình lập trình AI.

Lưu ý, khi sử dụng phương pháp này, tất cả các dòng chú thích đều phải có cùng độ thụt lề. Nếu chỉ cần có một dòng nào đó có độ thụt lề khác với các dòng còn lại, thì lỗi sẽ xảy ra như ví dụ sau đây:

for i in range(3):
print("chú thích trong python")
"""
Ngày viết : 210121
Tác giả : Kiyoshi
"""
print("line",i)

Do độ thụt lùi của các dòng lệnh print và của các dòng chú thích trong lệnh for ở trên không đồng nhất, nên lỗi sau bị trả về:

  File "Main.py", line 8
print(i)
^
IndentationError: unexpected indent

Lý do là bởi so với hai dòng lệnh print ở trên print("chú thích trong python") và ở dưới print(i) thì độ thụt lùi của các dòng chú thích lại không giống nhau.
Chúng ta cần phải sửa độ thụt lề lại như sau:

for i in range(3):
print("chú thích trong python")
"""
Ngày viết : 210121
Tác giả : Kiyoshi
"""
print("line",i)

Do các dòng có độ thụt lề giống nhau nên kết quả vòng lặp for sẽ chạy mượt mà như sau:

chú thích trong python
line 0
chú thích trong python
line 1
chú thích trong python
line 2

Ứng dụng của chú thích trong python

Sử dụng chú thích trong python để lưu giữ thông tin

Khi phải viết một chương trình python quá dài, hoặc là một dự án với nhiều chương trình python gộp lại, bạn nên sử dụng chú thích trong python để lưu giữ các thông tin cần thiết như ngày giờ viết chương trình, tên người viết, mục tiêu viết, giải thích các mục con trong chương trình python v.v..
Điều này rất hữu ích khi chương trình xảy ra lỗi và bạn cần quay lại đâu đó trong chương trình để sửa lỗi, mà bạn lại không nhớ rõ dòng lệnh đó có ý nghĩa gì. Khi đó, nếu bạn đã chú thích ý nghĩa của câu lệnh đó, thì việc nhớ lại và sửa code sẽ dễ dàng hơn rất nhiều.

Đặc biệt trong các dự án lớn có nhiều người tham gia cùng viết chương trình, thì việc chú thích sẽ giúp các đồng đội trong team bạn hiểu rõ hơn từng bộ phận trong chương trình.
Giả sử có người mới tham gia dự án, bạn cũng sẽ không mất công sức để giải thích lại cho họ, hãy tự đọc chú thích và mày mò đi ha ha..

Sử dụng chú thích trong python để bỏ qua các câu lệnh

Ngoài cách sử dụng chú thích trong python để lưu giữ các thông tin cần thiết, bạn cũng có thể dùng chú thích bỏ qua câu lệnh trong python. Cách làm này gọi là comment out trong tiếng Anh, hay là コメントアウト trong tiếng Nhật.

Cách sử dụng chú thích để bỏ qua câu lệnh trong python giống như ví dụ sau đây:

price = 500
price = price * 1.08
print (price)

Nếu chạy chương trình trên, chúng ta sẽ có kết quả là:

150.0

Nếu chúng ta không muốn chạy dòng lệnh thứ 2 nữa, chúng ta có thể xoá nó. Tuy nhiên nếu chúng ta chỉ tạm thời không muốn chạy dòng lệnh này, hãy chú thích dòng lệnh thứ hai và bỏ qua chúng khi xử lý chương trình như sau:

price = 500
#price = price * 1.08
print (price)

Bằng việc biến dòng lệnh thứ hai thành chú thích trong python, chúng ta đã bỏ qua dòng lệnh đó khi xử lý chương trình. Do đó chỉ có dòng lệnh 1 và 3 được xử lý và kết quả trả về như sau:

100

Phím tắt comment trong Python

Tùy thuộc vào phần mềm viết code Python mà bạn dùng thì chúng ta sẽ có các cách dùng phím tắt khác nhau như dưới đây:

Phím tắt comment trong Notepad ++

Phím tắt comment trong Notepad++
Sau khi chọn các dòng code, chúng ta có thể sử dụng các tổ hợp phím sau để comment trong Notepad ++:

  • Ctrl + K: Chuyển vùng code được chọn thành comment
  • Ctrl + Q: Bỏ commet của vùng code được chọn

Phím tắt comment trong Visual Studio

Phím tắt comment trong Visual Studio
Sau khi chọn các dòng code, chúng ta có thể sử dụng các tổ hợp phím sau để comment trong Visual Studio:

  • Ctrl + K + C: Chuyển vùng code được chọn thành comment
  • Ctrl + K + U: Bỏ commet của vùng code được chọn

Phím tắt comment trong Sublime text 3

Phím tắt comment trong Sublime text 3

Sau khi chọn các dòng code, chúng ta có thể sử dụng các tổ hợp phím sau để comment trong Sublime text 3:

  • Ctrl + /: Chuyển vùng code được chọn thành comment
  • Ctrl + Shift + /: Bỏ commet của vùng code được chọn

Tổng kết

Trên đây Kiyoshi đã hướng dẫn bạn cách chú thích trong python rồi. Để nắm rõ nội dung bài học hơn, bạn hãy thực hành viết lại các ví dụ của ngày hôm nay nhé.

Và hãy cùng tìm hiểu những kiến thức sâu hơn về python trong các bài học tiếp theo.

HOME>> >>

Profile
きよしです!笑

Tác giả : Kiyoshi (Chis Thanh)

Kiyoshi là một cựu du học sinh tại Nhật Bản. Sau khi tốt nghiệp đại học Toyama năm 2017, Kiyoshi hiện đang làm BrSE tại Tokyo, Nhật Bản.