Khi viết mã bằng Python, điều quan trọng là phải đảm bảo rằng mã của bạn có thể dễ dàng được người khác hiểu. Đặt tên rõ ràng cho các biến, định nghĩa các hàm rõ ràng và sắp xếp mã của bạn là những cách tuyệt vời để thực hiện điều này.
Một cách tuyệt vời và dễ dàng khác để tăng khả năng đọc hiểu cho mã của bạn là sử dụng chú thích!
Trong bài viết này, ptdulieu cùng bạn sẽ tìm hiểu về Comment và user input trong Python, ngoài một số điều cơ bản về cách viết chú thích trong Python. Bạn sẽ học cách viết chú thích rõ ràng và súc tích, và khi nào bạn có thể không cần viết bất kỳ chú thích nào cả.
Table of Contents
Cơ bản về chú thích Python
Bình luận (Comment) dành cho nhà phát triển. Chúng mô tả các phần của mã khi cần thiết để giúp các lập trình viên, bao gồm cả bạn, hiểu rõ hơn.
Để viết bình luận trong Python, chỉ cần thêm dấu thăng # trước bình luận bạn muốn:
# This is a commentCách viết bình luận trong Python
Để thêm chú thích trong Python, hãy làm theo bốn bước sau:
- Đảm bảo rằng bình luận của bạn bắt đầu ở cùng mức thụt lề với mã bình luận.
- Bắt đầu bằng dấu thăng (#) và một khoảng trắng. Ký tự thăng báo cho trình thông dịch bỏ qua phần còn lại của dòng mã.
- Viết bình luận của bạn.
- Đóng bình luận của bạn bằng một dòng mới. Python sẽ bắt đầu đọc lại mã của bạn sau khi dòng chứa bình luận kết thúc.
Có 3 loại chú thích trong Python: Simple Comment, Block Comment, Inline Commnet.
Simple Comment (Comments một dòng trong Python)
Nhìn chung, một dòng chú thích bắt đầu bằng dấu thăng (#) và một ký tự khoảng trắng theo sau là chủ thích được đề cập cho đến hết dòng.
Các bình luận bằng văn bản phải có cùng mức độ chú thích với mã sau. Giống như ví dụ dưới một bình luận đơn giản có thể trông như thế này:
# chỉ định ngày mới nhất trong tập ngày là hôm nay
dt_today = processed_dt['last_date'].max()Python sẽ không tính chú thích này khi thông dịch. Khi chạy chương trình, bạn sẽ không thấy bất kỳ dấu hiệu nào về comment ở đó. Comment nằm trong source code để con người đọc, không phải để máy tính thực thi.
Block Comment (Comments nhiều dòng trong Python)
Block Comment được sử dụng để giải thích ngữ cảnh phức tạp hơn mà bạn không thể giải thích chỉ trong 1 dòng bình luận hoặc được sử dụng khi người đọc có thể không quen thuộc với mã được chia sẻ.
Về cơ bản, Block Comment chỉ là nhiều dòng bình luận đơn giản (Simple Comment), ví dụ:
# Đây là một comment nhiều dòng
# Bạn có thể sử dụng nhiều dấu thăng liên tiếp
# để tạo comments nhiều dòng trong Python.
print("Hello, World!")
Có một các chú thích nhiều dòng khác đó là sử dụng ba dấu nháy đơn (''') hoặc ba dấu nháy kép (""") trước và sau khối mã bạn muốn chú thích, như sau:
'''
Đây là một comment nhiều dòng
bằng cách sử dụng chuỗi ba dấu nháy đơn.
Bạn có thể viết nhiều dòng văn bản
bên trong chuỗi này.
'''
print("Hello, World!")
"""
Đây là một comment nhiều dòng
bằng cách sử dụng chuỗi ba dấu nháy kép.
Bạn có thể viết nhiều dòng văn bản
bên trong chuỗi này.
"""
print("Hello, World!")Docstring Comments
Docstring (documentation string) là một loại comment đặc biệt được sử dụng để ghi chú và mô tả các hàm, lớp, và module trong Python. Docstring được đặt ngay sau định nghĩa của hàm, lớp, hoặc module và được bao quanh bởi ba dấu nháy đơn (''') hoặc ba dấu nháy kép ("""). Docstring có thể được truy cập thông qua thuộc tính __doc__ của đối tượng.
def greet(name):
"""
Hàm này in ra lời chào với tên được cung cấp.
Tham số:
name (str): Tên của người cần chào.
Trả về:
None
"""
print(f"Hello, {name}!")
# Gọi hàm greet
greet("Alice")
# Truy cập docstring của hàm greet
print(greet.__doc__)Inline Comments
Inline Comment xảy ra trên cùng một dòng của một câu lệnh, sau code. Giống như các chú thích python khác, chúng bắt đầu bằng một dấu (#) và một khoảng trắng duy nhất.
def price_adjust(price):
return price * 0.13 # Price increase to adjust for inflation rateHàm input() trong Python
Trong Python, chúng ta sử dụng hàm input() để yêu cầu người dùng nhập dữ liệu. Với tư cách là tham số, chúng ta nhập văn bản mà chúng ta muốn hiển thị cho người dùng. Khi người dùng nhấn "enter", giá trị đầu vào được trả về. Chúng ta thường lưu trữ dữ liệu đầu vào của người dùng trong một biến để chúng ta có thể sử dụng thông tin trong chương trình của mình.
Đối với Python 3.+, chúng ta sử dụng phương thức input() trong khi Python 2.+ sử dụng phương thức raw input().
Lấy đầu vào số nguyên
Bạn nên lưu ý rằng hàm input() trả về dữ liệu đầu vào của người dùng dưới dạng chuỗi, ngay cả khi người dùng nhập số! Điều này có thể gây ra sự phức tạp nếu bạn muốn thực hiện bất kỳ phép tính nào với số đó. May mắn thay, bạn có thể dễ dàng chuyển đổi chuỗi thành số nguyên trong Python bằng cách sử dụng hàm int() này. Điều này cũng được gọi là ép kiểu. Xem thêm tại đây.
from datetime import date
yob = input("Vui lòng nhập năm sinh của bạn:")
print("Tuổi của bạn là:", date.today().year - int(yob))
#kết quả:
Vui lòng nhập năm sinh của bạn:
Ví dụ khác
gender = input("Hãy đăng ký giới tính của bạn:")
print("Cảm ơn sự hỗ trợ, giới tính của bạn là:", gender)
#kết quả: Hãy đăng ký giới tính của bạn:
Xử lý đầu vào Float
Khi xử lý các dữ liệu đầu vào số yêu cầu độ chính xác thập phân, chẳng hạn như giá cả hoặc phép đo, bạn cần chuyển đổi dữ liệu đầu vào của người dùng thành số dấu phẩy động. Điều này được thực hiện bằng cách sử dụng hàm float() chuyển đổi chuỗi thành số dấu phẩy động.
price = float(input("Nhập giá: "))
print("Giá là:", price)
#kết quả: Enter the price:
Comments là một phần quan trọng trong lập trình Python, giúp giải thích, mô tả và ghi chú về các phần của mã nguồn. Ngoài ra, bài viết cũng đã trình bày thêm về Python Input. Bằng cách triển khai xác thực đầu vào và xử lý lỗi, bạn có thể tạo các ứng dụng Python mạnh mẽ và thân thiện với người dùng.
