Hướng dẫn nhận xét Python này giải thích lý do tại sao nhận xét lại quan trọng và cách viết nhận xét một dòng, nhiều dòng và DocString trong Python
Lập trình là cách đào tạo máy tính giống như bộ não của con người. Nhận xét trong Python giúp các nhà phát triển giải thích và mô tả hoạt động của mã. Nếu nhà phát triển không ghi nhận xét vào mã, thì bất kỳ người nào khác sẽ khó biết những dòng mã này đang làm gì trong một chương trình
Quá trình này giúp dễ dàng tìm ra lỗi và giải quyết chúng, đồng thời giúp người khác dễ dàng tiếp tục làm việc trên cùng một đoạn mã
=> Đọc qua TẤT CẢ các hướng dẫn về Python tại đây
Bạn sẽ học được gì
Bình luận Python
Bất kể mã dài, trung bình hay nhỏ, nhận xét đều quan trọng trong tất cả các loại dự án lập trình cho dù chúng được viết bằng Java, Python, C/C++, v.v.
Mã không có nhận xét trở nên khó hiểu đối với các nhà phát triển và mất nhiều thời gian hơn để hoàn thành công việc. Phẩm chất của một nhà phát triển tốt là đề cập đến các nhận xét trong chương trình
Trong hướng dẫn này, chúng tôi sẽ đề cập đến những điều cơ bản về cách viết nhận xét bằng Python
Tại sao Nhận xét rất quan trọng
Bình luận là một phần thiết yếu của mọi chương trình. Chúng có thể có sẵn trong cấu trúc của các chuỗi tài liệu hoặc có thể là các giải thích nội tuyến sẽ giúp tìm hiểu các hàm phức tạp
Nó làm cho mã có thể đọc được và do đó giúp các lập trình viên nhớ những gì họ đã làm trong quá khứ khi làm việc trên bất kỳ dự án cụ thể nào. Hãy để chúng tôi lấy một ví dụ và hiểu tại sao các bình luận lại quan trọng trong mã
Chúng tôi đang cung cấp hai tình huống trong đó các nhà phát triển quyết định không viết nhận xét trong mã
cảnh 1. Một nhà phát triển đọc mã viết của chính mình
Nhà phát triển A đang làm việc trên một dự án “Dự án A” và phải nộp đúng hạn. Anh ấy đang ở trong một thời hạn chặt chẽ và không có cơ hội để tăng thời gian. Anh ấy đã hoàn thành công việc của mình một cách xuất sắc và nộp nó đúng thời hạn trước thời hạn của dự án
Nhưng anh ấy đã để lại công việc tài liệu bao gồm các nhận xét & hướng dẫn sử dụng dự án và nghĩ sẽ viết nó sau. Vào ngày tiếp theo của thời hạn, anh ấy nhận được một dự án khác “Dự án B” và bắt đầu làm việc với dự án đó. Anh ấy hoàn toàn quên viết phần tài liệu của dự án trước “Dự án A”
Thời gian trôi nhanh và sau 7 tháng, Khách hàng A cần sửa đổi “Dự án A” từ Nhà phát triển A. Khi Nhà phát triển A bắt đầu làm việc trên cùng một dự án, anh ta không thể tìm ra toàn bộ mã. Anh ta quên ý nghĩa của mã trong chương trình của chính mình
Kịch bản trên sẽ không xảy ra nếu Nhà phát triển A đã nhận xét đúng về mã của anh ấy
kịch bản 2. Khi các nhà phát triển khác đang cố đọc mã của bạn
Giả sử bạn đang thực hiện một dự án nhỏ và bạn biết rất rõ những gì bạn đã viết trong dự án. Trong tình huống này, bạn đã không viết bình luận trong mã vì bạn nghĩ rằng bình luận là cần thiết. Như chúng ta đều biết, viết bình luận cần thời gian
Nhưng khi nhà phát triển mới phải tiếp tục công việc trên cùng một dự án, anh ấy/cô ấy sẽ hiểu mã như thế nào?
Nhà phát triển mới không biết những gì được viết trong mã. Trong kịch bản này, rõ ràng là các comment rất quan trọng trong mọi đoạn mã, bất kể đó là dự án nhỏ hay dự án lớn. Họ sẽ giúp các nhà phát triển mới tiếp tục công việc trên các dự án tương tự
Cách viết bình luận trong Python
Hãy cho chúng tôi hiểu cách viết nhận xét trong mã Python với các ví dụ
Khái niệm cơ bản về nhận xét trong Python
Nhận xét được viết cho các nhà phát triển mới tiếp tục dự án được viết bởi các nhà phát triển khác. Họ thuật lại đoạn mã theo yêu cầu để giải thích logic và luồng chương trình
Trong Python dấu băm “#” được sử dụng trước khi bắt đầu dòng mã để viết bình luận
Thí dụ
``` # This is the comment in Python ```
Python sẽ bỏ qua dòng mã bắt đầu bằng dấu thăng “#”. Nhà phát triển có thể thêm nhận xét vào bất kỳ đâu trong mã
Thí dụ
``` print[ “ Welcome to the SoftwareTestingHelp Website ” ] # This is the first statement ```
Sau khi chạy đoạn mã trên, bạn sẽ thấy đầu ra giống như “Chào mừng bạn đến với Trang web trợ giúp kiểm tra phần mềm”, câu lệnh bắt đầu bằng “#” sẽ bị bỏ qua
Ghi chú. Nhận xét phải nhỏ, lịch sự và đi thẳng vào vấn đề. Độ dài tối đa của bình luận là 72 ký tự và nếu vượt quá giới hạn thì người dùng sẽ cần chia bình luận thành nhiều dòng
Các loại bình luận trong Python
Nhận xét một dòng
Python có một cách khác để viết bình luận khi so sánh với các ngôn ngữ lập trình khác như C, Java, v.v. Trong Nhận xét một dòng, chỉ có dấu thăng “#” được sử dụng ở đầu dòng
Thí dụ
``` # This is the SIngle Line Comment Welcome to SoftwareTestingHelp Thanks! ```
Trong ví dụ này, dòng mã đầu tiên sẽ bị bỏ qua vì nó có dấu “#” và các dòng còn lại sẽ tạo ra lỗi Cú pháp vì chúng không phải là câu lệnh Python hợp lệ và chúng cũng không được nhận xét
Nhận xét nhiều dòng trong Python
Hãy so sánh comment nhiều dòng trong Java với Python. Bạn có thể hiểu nó với một ví dụ
Ví dụ nhận xét Java
``` /* This is the multiline Comment in Java Welcome to SoftwareTestingHelp Thanks */ ```
Trong Java comment nhiều dòng được viết như hình trên. “ /*” dùng để bắt đầu bình luận và “ /*” dùng để kết thúc bình luận. Các dòng giữa /* và */ sẽ bị bỏ qua khi thực hiện chương trình
Nhưng Python không hỗ trợ nhận xét nhiều dòng gốc như các ngôn ngữ khác. Để tạo comment nhiều dòng trong Python, chúng ta có 2 cách
- Chúng ta chỉ cần thêm “#” vào đầu mỗi dòng như hình bên dưới
``` def demo[]: # Welcome to SoftwareTestingHelp # Thanks ```
Tất cả các dòng trên bắt đầu bằng ” # “ sẽ bị bỏ qua khi thực hiện chương trình. Kỹ thuật trên được gọi là bình luận khối. Ở đây, chúng tôi sử dụng “#” ở đầu mỗi dòng để coi đó là một nhận xét
- Một cách khác là sử dụng ba dấu ngoặc kép “ “”” “ ở đầu và cuối của nhận xét nhiều dòng như được đưa ra bên dưới
``` def demo[]: “”” Welcome to SoftwareTestingHelp Thanks “”” ```
DocString Nhận xét
Tài liệu Chuỗi là các chuỗi được viết trong dấu nháy kép [“”] hoặc dấu nháy đơn [‘‘] và đóng vai trò là chú thích trong chương trình. Về cơ bản chúng được sử dụng cho phần tài liệu. Trong một số hàm hoặc lớp khi chúng ta click hoặc gọi chúng thì nó sẽ hiện ra tài liệu của nó
Hãy để chúng tôi lấy ví dụ
```
def demo[]:
"""
This function will take the input from the user and
print the factorial of a number.
If the input is negative than it will generate
an error.
"""
fact = 1
a = int[input["Enter the number"]]
if a > 0:
print[" The number is greater than zero.", a]
for i in range [1, a+1]:
fact = fact * i
print["The factorial of a given number is:", fact]
elif a == 0:
print["The factorial of a given number is: ", a]
else:
print["This number is not valid! Please enter the correct number"]
demo[]
```
đầu ra
Nếu chúng ta gọi hàm là “demo” với “. __doc__”, từ khóa, như “demo. __doc__” Điều gì sẽ xảy ra?
Nó sẽ hiển thị tài liệu về chức năng mà chúng ta đã viết trong dấu ngoặc kép
Sự khác biệt giữa Nhận xét và Nhận xét DocString
DocString CommentCommentDocString không bị trình thông dịch Python bỏ qua. Bình luận được bỏ qua bởi thông dịch viên. Nó được sử dụng cho các tài liệu. Nó đóng vai trò là gợi ý cho các lập trình viên để hướng dẫn họ những gì đang xảy ra trong mã. Để truy cập phần tài liệu “. _doc_” từ khóa được sử dụng. Để truy cập các lập trình viên nhận xét không cần bất kỳ từ khóa nào
Nhận xét lịch sự v/s Nhận xét thô lỗ
Như chúng ta đã thảo luận ở trên, các bình luận nên lịch sự và nhỏ gọn để mọi người có thể dễ dàng hiểu được. Nhưng có thể có khả năng nhận xét thô lỗ trong chương trình. Nhận xét lịch sự v/s Nhận xét thô lỗ.
Thí dụ
``` def demo[] a = 10 # Assigning the value of a b = 15 Sum = a +b # Calculating the sum of two numbers return Sum ```
Trong ví dụ trên, các bình luận rất đơn giản và dễ hiểu và nhìn đẹp
Thí dụ
________số 8Trong ví dụ trên, bình luận là rất thô lỗ. Nó sẽ làm giảm động lực của các nhà phát triển mới trước khi làm việc với dự án mới
Ghi chú. Luôn tránh những bình luận khiếm nhã
Thông lệ chung
Thông thường, bắt đầu một tệp Python với một vài dòng nhận xét. Những dòng này mô tả thông tin liên quan đến dự án, mục đích của tệp, lập trình viên đã phát triển nó hoặc đã làm việc với nó và giấy phép phần mềm được sử dụng cho mã
Nhận xét bắt đầu bằng phần phác thảo và theo sau là thông báo bản quyền với tên của nhà phát triển và do đó là năm xuất bản mã cụ thể. Mã này được công nhận theo Giấy phép Công cộng GNU [GPL]
Thí dụ
Bao gồm định dạng sau trong mỗi tệp của dự án của bạn
``` “”” < Brief description of the purpose of this file > Copyright 2021, Organization name Distributed under the terms of the GPL License. Author: Author name “”” ```
Nhận xét được đưa vào khi tạo một lớp hoặc một hàm
``` print[ “ Welcome to the SoftwareTestingHelp Website ” ] # This is the first statement ```0
Các câu hỏi thường gặp
Q #1] Bạn viết bình luận bằng Python như thế nào?
Câu trả lời. Trong Python, chú thích được sử dụng để mô tả mã được viết trong chương trình. Vì vậy, trong tương lai, nếu bất kỳ nhà phát triển mới nào muốn làm việc trong cùng một dự án, họ sẽ có thể hiểu mã với sự trợ giúp của các nhận xét được đề cập trong chương trình
Nhận xét được viết bằng dấu thăng [#] ở đầu dòng
Thí dụ
“`
# Chào mừng bạn đến với Trợ giúp kiểm thử phần mềm
“`
Q #2 ] Làm cách nào để bạn nhận xét nhiều dòng trong Python?
Câu trả lời. Trong Python, để comment nhiều dòng code trong chương trình, lập trình viên có thể sử dụng 2 cách như đã trình bày ở trên trong hướng dẫn này
- Sử dụng dấu thăng ở đầu mỗi dòng
``` print[ “ Welcome to the SoftwareTestingHelp Website ” ] # This is the first statement ```1
- Sử dụng ba dấu ngoặc kép ở đầu và cuối bình luận
``` print[ “ Welcome to the SoftwareTestingHelp Website ” ] # This is the first statement ```2
Câu hỏi 3] Việc sử dụng nhận xét trong Python là gì?
Câu trả lời. Nhận xét được sử dụng để mô tả logic của mã được viết trong chương trình. Nhận xét giúp người dùng mới và nhà phát triển hiểu mã và tiếp tục công việc của họ trên cùng một dự án
Q #4] Làm cách nào để chặn nhận xét trong Python?
Câu trả lời. Trong Python, các chú thích khối được sử dụng để mô tả mã phức tạp. Trong các bình luận khối, mỗi dòng bắt đầu bằng dấu thăng “#” ở đầu. Nếu nhà phát triển muốn bình luận trên một hoặc hai hoặc nhiều đoạn văn, thì chúng sẽ được phân tách bằng một dòng có một dấu thăng
Thí dụ
``` print[ “ Welcome to the SoftwareTestingHelp Website ” ] # This is the first statement ```3
Sự kết luận
Nhận xét được sử dụng để hiểu các tập lệnh mã. Chúng bị trình thông dịch bỏ qua trong quá trình thực thi mã. Chúng được sử dụng để làm cho mã chương trình Python dễ đọc hơn và nó sẽ giúp các nhà phát triển mới tiếp tục làm việc trên bất kỳ dự án nào
Ngoài ra, hãy nhớ rằng một trong những cách tốt nhất để học cách viết mã và nhận xét tốt hơn là đọc mã của người khác và nhận xét của họ được viết trong chương trình