Cách viết comment bằng Python 3
Chú thích là những dòng tồn tại trong chương trình máy tính bị trình biên dịch và thông dịch bỏ qua. Bao gồm các comment trong chương trình làm cho mã dễ đọc hơn đối với con người vì nó cung cấp một số thông tin hoặc giải thích về những gì mỗi phần của chương trình đang thực hiện.Tùy thuộc vào mục đích chương trình của bạn, các comment có thể dùng như ghi chú cho chính bạn hoặc nhắc nhở, hoặc chúng có thể được viết với mục đích để các lập trình viên khác có thể hiểu mã của bạn đang làm gì.
Nói chung, bạn nên viết comment khi đang viết hoặc cập nhật một chương trình vì rất dễ quên quá trình suy nghĩ của bạn sau này và những comment được viết sau đó có thể ít hữu ích hơn về lâu dài.
Cú pháp comment
Comment trong Python bắt đầu bằng dấu thăng ( # ) và ký tự khoảng trắng và tiếp tục đến cuối dòng.
Nói chung, các comment sẽ giống như sau:
# This is a comment Bởi vì comment không thực thi, khi bạn chạy một chương trình, bạn sẽ không thấy bất kỳ dấu hiệu nào về comment ở đó. Chú thích nằm trong mã nguồn để con người đọc, không phải để máy tính thực thi.
Trong câu "Xin chào, Thế giới!" chương trình, một comment có thể trông như thế này:
# Print “Hello, World!” to console print("Hello, World!") Trong vòng lặp for lặp qua một danh sách , các comment có thể giống như sau:
# Define sharks variable as a list of strings sharks = ['hammerhead', 'great white', 'dogfish', 'frilled', 'bullhead', 'requiem'] # For loop that iterates over sharks list and prints each string item for shark in sharks: print(shark) Comment phải được thực hiện ở cùng một thụt lề với mã mà nó đang comment . Đó là, một định nghĩa hàm không có thụt lề sẽ có comment không có thụt lề và mỗi cấp độ thụt lề sau sẽ có các comment phù hợp với mã mà nó đang comment .
Ví dụ: đây là cách hàm again() từ hướng dẫn Cách tạo chương trình máy tính đơn giản trong Python 3 được comment , với các comment sau mỗi mức thụt lề của mã:
... # Define again() function to ask user if they want to use the calculator again def again(): # Take input from user calc_again = input(''' Do you want to calculate again? Please type Y for YES or N for NO. ''') # If user types Y, run the calculate() function if calc_again == 'Y': calculate() # If user types N, say good-bye to the user and end the program elif calc_again == 'N': print('See you later.') # If user types another key, run the function again else: again() Comment được đưa ra để giúp các lập trình viên, cho dù đó là lập trình viên ban đầu hay người khác sử dụng hoặc cộng tác trong dự án. Nếu comment không thể được duy trì và cập nhật đúng cách cùng với cơ sở mã, tốt hơn là không bao gồm comment hơn là viết comment mâu thuẫn hoặc sẽ mâu thuẫn với mã.
Khi comment mã, bạn nên tìm cách trả lời lý do đằng sau mã thay vì cái gì hoặc như thế nào . Trừ khi mã đặc biệt phức tạp, nhìn vào mã có thể biết mã đang làm gì hoặc nó đang hoạt động như thế nào.
Chặn comment
Comment khối được dùng để giải thích mã hoặc mã phức tạp hơn mà bạn không mong đợi người đọc quen thuộc. Các comment dạng dài hơn này áp dụng cho một số hoặc tất cả mã theo sau và cũng được thụt lề ở cùng cấp với mã.
Trong các comment khối, mỗi dòng bắt đầu bằng dấu thăng và một khoảng trắng. Nếu bạn cần sử dụng nhiều hơn một đoạn, chúng nên được phân tách bằng một dòng chứa một dấu thăng.
Dưới đây là một ví dụ về một comment khối xác định những gì đang xảy ra trong hàm main() được định nghĩa bên dưới:
# The main function will parse arguments via the parser variable. These # arguments will be defined by the user on the console. This will pass # the word argument the user wants to parse along with the filename the # user wants to use, and also provide help text if the user does not # correctly pass the arguments. def main(): parser = argparse.ArgumentParser() parser.add_argument( "word", help="the word to be searched for in the text file." ) parser.add_argument( "filename", help="the path to the text file to be searched through" ) ... Comment khối thường được sử dụng khi các hoạt động ít đơn giản hơn và do đó yêu cầu giải thích kỹ . Bạn nên cố gắng tránh comment quá nhiều mã và nên có xu hướng tin tưởng các lập trình viên khác hiểu Python trừ khi bạn đang viết cho một đối tượng cụ thể.
Comment nội tuyến
Comment nội dòng xảy ra trên cùng một dòng của một câu lệnh, sau chính mã. Giống như các comment khác, chúng bắt đầu bằng dấu thăng và một ký tự khoảng trắng duy nhất.
Nói chung, các comment nội dòng trông như thế này:
[code] # Inline comment about the code Comment nội tuyến nên được sử dụng một cách tiết kiệm, nhưng có thể hiệu quả để giải thích các phần phức tạp hoặc không rõ ràng của mã. Chúng cũng có thể hữu ích nếu bạn nghĩ rằng bạn có thể không nhớ một dòng mã bạn đang viết trong tương lai hoặc nếu bạn đang cộng tác với một người mà bạn biết có thể không quen thuộc với tất cả các khía cạnh của mã.
Ví dụ: nếu bạn không sử dụng nhiều toán học trong các chương trình Python của bạn , bạn hoặc cộng tác viên của bạn có thể không biết rằng phần sau tạo ra một số phức, vì vậy bạn có thể cần đưa vào một comment nội tuyến về điều đó:
z = 2.5 + 3j # Create a complex number Comment nội tuyến cũng được dùng để giải thích lý do đằng sau việc làm gì đó hoặc một số thông tin bổ sung, như trong:
x = 8 # Initialize x with an arbitrary number Các comment được đưa ra theo dòng chỉ nên được sử dụng khi cần thiết và khi chúng có thể cung cấp hướng dẫn hữu ích cho người đọc chương trình.
Comment ra mã để thử nghiệm
Ngoài việc sử dụng comment như một cách để ghi lại mã, dấu thăng cũng được dùng để comment mã mà bạn không muốn thực thi trong khi bạn đang thử nghiệm hoặc gỡ lỗi một chương trình bạn hiện đang tạo. Đó là, khi bạn gặp lỗi sau khi triển khai các dòng mã mới, bạn có thể cần comment một vài trong số chúng để xem liệu bạn có thể khắc phục sự cố chính xác hay không.
Sử dụng dấu thăng cũng có thể cho phép bạn thử các lựa chọn thay thế trong khi xác định cách cài đặt mã của bạn . Ví dụ, bạn có thể quyết định giữa việc sử dụng mộtwhile vòng lặp hoặc một for vòng lặp trong một trò chơi Python, và có thể comment ra cái này hay cái khác trong khi thử nghiệm và xác định mà người ta có thể là tốt nhất:
import random number = random.randint(1, 25) # number_of_guesses = 0 for i in range(5): # while number_of_guesses < 5: print('Guess a number between 1 and 25:') guess = input() guess = int(guess) # number_of_guesses = number_of_guesses + 1 if guess < number: print('Your guess is too low') if guess > number: print('Your guess is too high') if guess == number: break if guess == number: print('You guessed the number!') else: print('You did not guess the number. The number was ' + str(number)) Comment mã bằng dấu thăng có thể cho phép bạn thử các phương pháp lập trình khác nhau cũng như giúp bạn tìm ra nguồn root của lỗi thông qua comment một cách có hệ thống và các phần đang chạy của chương trình.
Kết luận
Sử dụng comment trong các chương trình Python của bạn giúp làm cho các chương trình của bạn dễ đọc hơn đối với con người, bao gồm cả bản thân bạn trong tương lai. Bao gồm các comment phù hợp có liên quan và hữu ích có thể giúp người khác dễ dàng cộng tác với bạn trong các dự án lập trình và làm cho giá trị của mã của bạn rõ ràng hơn.
Từ đây, bạn có thể cần đọc về Docstrings của Python trong PEP 257 để cung cấp cho bạn nhiều tài nguyên hơn để ghi lại các dự án Python của bạn một cách chính xác.
Các tin liên quan
Cách xác định hàm trong Python 32017-02-28
Phân tích và trực quan hóa dữ liệu với pandas và notebook Jupyter bằng Python 3
2017-02-23
Cách vẽ biểu đồ tần suất từ bằng matplotlib với Python 3
2017-02-17
Cách cài đặt gói pandas và làm việc với cấu trúc dữ liệu trong Python 3
2017-02-10
Cách cài đặt gói pandas và làm việc với cấu trúc dữ liệu trong Python 3
2017-02-10
Cách cài đặt gói pandas và làm việc với cấu trúc dữ liệu trong Python 3
2017-02-10
Cách viết module trong Python 3
2017-02-03
Cách cài đặt Python 3 và thiết lập môi trường lập trình trên server Ubuntu 16.04
2017-02-01
Cách khai báo module trong Python 3
2017-02-01
Hiểu Tuples trong Python 3
2017-01-19
