Chú Thích Trong Python

Trang chủ » Các Loại Ghi Chú Trong Python » Chú Thích Trong Python

Có thể bạn quan tâm

Hướng dẫn cách comment trong python. Trong lập trình Python, “comment” là một khái niệm quan trọng và một phần không thể thiếu của việc viết mã. Comment là các dòng văn bản được thêm vào mã nguồn để giải thích, mô tả hoặc ghi chú về mã, giúp cho việc đọc và hiểu mã dễ dàng hơn cho người đọc, bao gồm cả bản thân bạn khi bạn quay lại kiểm tra hoặc cải thiện mã. Trong bài viết này, chúng ta sẽ tìm hiểu về tầm quan trọng của comment trong Python, cách sử dụng chúng, và quy tắc tốt để viết comment hiệu quả.

comment trong python là gì

comment 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 comment 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.

Tại sao cần sử dụng comment?

Comment đóng vai trò quan trọng trong lập trình Python vì chúng giúp:

  • Giải thích mã nguồn: Comment cho phép bạn giải thích ý nghĩa và cách hoạt động của mã. Điều này rất hữu ích cho người đọc, đặc biệt là nếu họ không phải là người viết mã.

  • Ghi chú và ghi nhớ: Comment cũng được sử dụng để ghi chú về công việc cần thực hiện hoặc để ghi nhớ các điểm quan trọng trong mã.

  • Dự phòng và sửa lỗi: Comment có thể được sử dụng để tạm thời vô hiệu hóa một phần mã (được gọi là “comment out”) để kiểm tra hoặc sửa lỗi mà không xóa hoặc thay đổi mã gốc.

  • Phân loại và tạo cấu trúc mã: Comment có thể được sử dụng để phân loại mã, tạo cấu trúc mã và tạo tiêu đề cho các phần khác nhau của mã.

Cách sử dụng comment trong Python

Python cho phép sử dụng hai loại comment chính: comment dòng và comment đa dòng.

Comment dòng (Single-Line Comments):

Comment dòng là những dòng văn bản bắt đầu bằng ký tự #. Mọi thứ sau ký tự # trong dòng đó được coi là comment và sẽ không được thực thi. Ví dụ:

Copy
# Đây là một comment dùng để giải thích mãx = 10 # Gán giá trị 10 vào biến x

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

# text

Trong đó text là nội dung comment được ghi sau dấu #.

comment trong python sẽ được tính từ đằng sau dấu # cho tới cuối dòng . Chúng ta có thể comment 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:

Copy
### 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ìnhprint(age)

Lưu ý rằng chúng ta không thể comment 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:

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

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

Copy
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

Comment đa dòng (Multi-Line Comments):

Python không cung cấp cú pháp chính thức để tạo comment đa dòng, nhưng bạn có thể sử dụng chuỗi đa dòng (triple-quoted string) để tạo comment đa dòng. Ví dụ:

Copy
"""Đây là một comment đa dòngDùng để giải thích mã nguồn"""x = 10

Để comment đa dòng trong python, chúng ta viết các dòng comment 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 comment 1dòng comment 2…"""

Hoặc

'''dòng comment 1dòng comment 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.

  • Về cách khai báo chuỗi nhiều dòng trong python, bạn có thể tham khảo chi tiết tại bài khai báo chuỗi trong python

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

Copy
"""Ngày viết : 210121Tác giả : Kiyoshi"""print("comment trong python")

Bạn có thể thấy cách comment 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 comment đề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:

Copy
for i in range(3): print("comment trong python")"""Ngày viết : 210121Tá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 comment trong lệnh for ở trên không đồng nhất, nên lỗi sau bị trả về:

Copy
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("comment trong python") và ở dưới print(i) thì độ thụt lùi của các dòng comment lại không giống nhau.Chúng ta cần phải sửa độ thụt lề lại như sau:

Copy
for i in range(3): print("comment 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:

Copy
comment trong pythonline 0comment trong pythonline 1comment trong pythonline 2

Quy tắc tốt khi viết comment

Việc viết comment hiệu quả là một kỹ năng quan trọng trong lập trình Python. Dưới đây là một số quy tắc tốt để bạn lưu ý:

  • Sử dụng comment khi cần thiết: Viết comment cho các dòng mã quan trọng, khó hiểu hoặc cần giải thích. Tránh viết comment cho mọi dòng mã, vì điều này có thể làm cho mã trở nên rối ren.

  • Sử dụng comment mô tả chức năng: Sử dụng comment để giải thích chức năng hoặc mục tiêu của một phần mã, không chỉ làm trạng thái hiện tại.

  • Sử dụng ngôn ngữ mô tả rõ ràng: Sử dụng ngôn ngữ mô tả rõ ràng và tránh viết comment quá dài và phức tạp.

  • Cập nhật comment: Hãy nhớ cập nhật comment khi bạn thay đổi mã. Comment lỗi có thể là nguy cơ nếu chúng không còn đúng với mã.

  • Sử dụng comment dưới dạng tài liệu: Bạn có thể sử dụng các công cụ tạo tài liệu như Sphinx để tạo tài liệu tự động từ các comment trong mã của bạn. Điều này giúp bạn tạo tài liệu chất lượng cao cho mã của mình.

Ứng dụng của comment trong python

Sử dụng comment 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 comment 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 đã comment ý 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 comment 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 comment và mày mò đi ha ha..

Sử dụng comment trong python để bỏ qua các câu lệnh

Ngoài cách sử dụng comment trong python để lưu giữ các thông tin cần thiết, bạn cũng có thể dùng comment 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 comment để bỏ qua câu lệnh trong python giống như ví dụ sau đây:

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

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

Copy
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 comment dòng lệnh thứ hai và bỏ qua chúng khi xử lý chương trình như sau:

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

Bằng việc biến dòng lệnh thứ hai thành comment 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:

Copy
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 StudioSau 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 comment trong python rồi. Comment là một phần quan trọng của lập trình Python, giúp bạn giải thích, mô tả, và tạo cấu trúc mã của mình. Việc viết comment hiệu quả và theo các quy tắc tốt sẽ giúp mã của bạn dễ đọc, dễ hiểu và dễ bảo trì. Hãy sử dụng comment một cách thông minh trong quá trình phát triển mã của bạn để tạo mã dễ quản lý và hiệu quả hơn.

URL Link

https://laptrinhcanban.com/python/nhap-mon-lap-trinh-python/kien-thuc-can-ban-ve-chuong-trinh-python/chu-thich-trong-python/

Từ khóa » Các Loại Ghi Chú Trong Python