Làm thế nào để nhận xét mã Python

Chú thích là một dòng mã của chương trình phần mềm không ảnh hưởng đến việc thực thi chương trình. Nó bị các chương trình biên dịch và thông dịch bỏ qua và chỉ ở đó để truyền đạt thông tin gì đó cho người đọc mã.

Chú thích được sử dụng phổ biến trong các ngôn ngữ lập trình. Mặc dù là một cách được khuyến nghị để tăng khả năng đọc mã của một người, nhưng các lập trình viên phải mất một thời gian để phát triển thói quen lành mạnh là sử dụng các bình luận ở mức tốt nhất có thể.

Trong bài viết này, chúng ta sẽ đi sâu vào cách sử dụng comment trong lập trình Python.

Mục đích của nhận xét trong mã

Mặc dù chúng không đóng bất kỳ vai trò trực tiếp nào trong việc thực hiện chương trình, nhưng các bình luận cũng không phải là vô dụng. Sau đây là các mục đích mà chúng phục vụ trong mã của chương trình:

  1. Nâng cao khả năng đọc cho người viết mã khi họ cần truy cập lại mã sau nhiều tháng
  2. Cộng tác nhóm tốt hơn vì mọi người đều hiểu mã do thành viên khác viết
  3. Nhận xét mã để thử nghiệm

Khái niệm cơ bản về nhận xét Python

Mỗi ngôn ngữ có một cú pháp khác nhau để nhận xét. Python sử dụng dấu '#' (dấu thăng) để chuyển tải tới trình thông dịch để bỏ qua văn bản sau biểu tượng băm.

  • Mã số: 

#Interpreter bỏ qua điều này.

# Đây là một nhận xét

print (“Cái này được in.”) # Đây là hàm in python.

#print (“Cái này không được in.”)

Khi bạn chạy mã này, điều duy nhất đầu ra hiển thị là Điều này sẽ được in. Mọi thứ khác đều được bình luận. 

Ví dụ được hiển thị ở đây cho thấy việc sử dụng các chú thích Python. Tuy nhiên, nhận xét nên được sử dụng để giải thích những gì một dòng mã, khối hoặc chức năng cụ thể đạt được cho chương trình.

Ngoài ra, nhận xét phải luôn được thụt vào ở cùng cấp với mã mà nó tìm cách giải thích.

Mã số:

#For Loop lặp lại từ i = 1 đến i = 9

cho tôi trong phạm vi (1,10):

in (i)

Nhận xét nội tuyến bằng Python 

Trong khi các nhận xét được sử dụng trong việc giải thích các dòng mã hoặc chức năng sắp tới, các nhận xét nội tuyến chỉ dành riêng cho một câu lệnh. Chúng được viết ngay sau tuyên bố. Chúng bắt đầu bằng '#' giống như bất kỳ nhận xét nào khác và thường ngắn hơn về số lượng từ.

Nhận xét nội tuyến nên được sử dụng một cách tiết kiệm, vì chúng có khả năng làm tắc nghẽn mã. Các lập trình viên sử dụng chúng khi có một logic phức tạp đối với một dòng trong mã, điều này có thể không rõ ràng đối với các thành viên khác trong nhóm hoặc thậm chí chính họ sau một vài tháng.

Ví dụ:

X = 8 + pi * theta # Dòng này tạo một số ngẫu nhiên cho chúng ta trên mỗi lần lặp.

Nhận xét nhiều dòng bằng Python

Về mặt kỹ thuật, Python không có cơ sở nhận xét đa dòng. 

  • Mã số:

# Tôi muốn

tạo một bình luận nhiều dòng.

Bạn có thể thử một cái gì đó như thế này, chỉ để nhận ra rằng trình thông dịch bỏ qua dòng đầu tiên và hiển thị lỗi trong dòng tiếp theo. 

Tuy nhiên, có một số cách giải quyết mà các lập trình viên Python sử dụng để tạo các nhận xét đa dòng, như sau.

  1. Chặn nhận xét

Các bình luận chặn không là gì ngoài nhiều bình luận một dòng. Ở đầu mỗi dòng, lập trình viên sử dụng một dấu thăng để nhận xét dòng đơn đó. Khi điều này được thực hiện nhiều lần, kết quả là nhận xét nhiều dòng dài hơn, còn được gọi là nhận xét khối.

  • Mã số:

#Tôi muốn

#create a multiline

#bình luận.

Mặc dù đây có vẻ là một giải pháp không phức tạp, nhưng ngay cả các lập trình viên Python chuyên nghiệp cũng sử dụng nó cho các dự án của họ ở mọi quy mô. Chặn nhận xét cung cấp một cách rất thuận tiện để giải thích mã phức tạp cần giải thích dài hơn một vài từ.

  1. Dấu ngoặc kép

Sử dụng một dấu ngoặc kép để thêm một nhận xét nhiều dòng là một phương pháp phổ biến đối với những người thực hành Python. Về mặt kỹ thuật, đây không phải là một nhận xét mà là một chuỗi. Tuy nhiên, vì chuỗi không được chỉ định ở bất kỳ đâu cũng như không được tham chiếu cho bất kỳ tác vụ nào, sự hiện diện của nó trong mã không ảnh hưởng đến kết quả.

  • Mã số: 

“Đây là một bình luận nhiều dòng

mà mọi người thường sử dụng trong Python. Tuy vậy,

đây không thực sự là một nhận xét mà là một

dây. Nếu chúng tôi chạy mã này, chuỗi này sẽ không

xuất hiện trong đầu ra. “

Nhận xét mã trong khi thử nghiệm

Ngoài việc tăng khả năng đọc của mã, các lập trình viên Python thường sử dụng các chú thích theo một cách hơi khác. Các nhà phát triển có thể nhận xét để loại trừ mã mà họ không muốn sử dụng vào lúc này. Nó giúp họ gỡ lỗi mã tốt hơn và tập trung đặc biệt vào phần mà họ quan tâm.

  • Mã số:

dự đoán = model.posystem_generator (test_generator, các bước = nb_samples)

đánh giá = model.evaluate_generator (test_generator, các bước = nb_samples)

#import matplotlib.pyplot as plt

# plt.plot (range (nb_samples), dự đoán)

# plt.xlabel ('chỉ mục của hình ảnh thử nghiệm')

# plt.ylabel ('Dự đoán')

# plt.title ('Dự đoán Lớp học')

# plt.show ()

Ở đây, phần vẽ biểu đồ đã được nhận xét là chỉ tập trung vào các biến số dự đoán và đánh giá.

Phần kết luận

Bình luận Python cung cấp một chức năng rất hữu ích giúp cải thiện năng suất của một lập trình viên về lâu dài. Nó không chỉ làm cho mã dễ đọc hơn mà còn tăng hiệu quả hợp tác nhóm trong các dự án lớn. Một lập trình viên giỏi viết mã tốt; một lập trình viên tuyệt vời thêm nhận xét vào nó.

Tham khảo một số dịch vụ khác của VDO:

Thuê chỗ đặt máy chủ – Thuê server – Thuê VPS – Thuê phần cứng máy chủ – Thuê tủ Rack- Thuê Cloud Server - Dịch vụ GPU server

Địa chỉ liên hệ VDO: – VPGD HN: Tầng 2, số 61 Mễ Trì Thượng, Phường Mễ Trì, Quận Nam Từ Liêm,Thành Phố Hà Nội. – Tel: 024 7305 6666 – VPGD TPHCM: Phòng 13.09, Lô C, Số 974A Trường Sa (Co.opmart Nhiêu Lộc), Phường 12, Quận 3, Hồ Chí Minh. – Tel: 028 7308 6666 – Contact Center: 1900 0366 – Email: info@vdo.vn – Website: https://vdodata.vn/

Nhận xét

Đăng nhận xét

Bài đăng phổ biến từ blog này

Sự khác biệt giữa Ảo hóa và Điện toán đám mây

Hình ảnh
  Trong thời đại ngày nay, hầu hết các doanh nghiệp đã chuyển toàn bộ hoặc một phần hoạt động sang trực tuyến.  Thông thường, chúng ta nghe nói rằng một công nghệ này tốt hơn công nghệ kia để một doanh nghiệp phát triển mạnh trong ngành công nghiệp web.  Một trong những công nghệ đã trở thành một từ thông dụng gần đây là 'Điện toán đám mây'.  Điện toán đám mây là một thuật ngữ được sử dụng cho mọi thứ liên quan đến đám mây.  Có thể là dịch vụ đám mây, hệ thống đám mây, nền tảng, dịch vụ lưu trữ web, v.v. Thêm vào đó là thực tế là có một số người nói rằng đám mây là ảo (đó là sự thật) và do đó, điện toán đám mây và ảo hóa là giống nhau (tốt đây không phải là '' t hoàn toàn đúng). Trong bài viết này, chúng tôi nhằm mục đích giúp giải quyết sự nhầm lẫn sự khác nhau giữa Ảo hóa và Điện toán đám mây và giải thích chi tiết từng loại. Trước tiên, chúng ta hãy bắt đầu bằng cách hiểu Ảo hóa là gì. Ảo hóa hay  nói cách đơn giản là việc tạo ra một tài nguyên ở dạng ảo...
Đọc thêm

6 Lợi ích của việc chuyển sang lưu trữ đám mây

  Khi bạn mới tham gia vào ngành công nghiệp web và dự định  lưu trữ trang web  hoặc blog  đầu tiên của  mình, có rất nhiều câu hỏi trong đầu bạn.  Tôi nên sử dụng dịch vụ miễn phí hay dịch vụ cao cấp?  Đây có phải là thời điểm thích hợp để đầu tư vào một dịch vụ trả phí và nếu có, tôi chọn dịch vụ lưu trữ nào? Cuối cùng, hầu hết các chủ sở hữu trang web đều chọn Shared Hosting vì nó cung cấp các tính năng tốt cho người mới bắt đầu và giá cả cũng khá phải chăng.  Theo thời gian, doanh nghiệp của bạn phát triển và lưu lượng truy cập cũng vậy.  Đó là lúc bạn nghĩ - vì lưu lượng truy cập trang web của tôi đã tăng lên nên thời gian tải quá nhiều,  tôi nên chuyển sang lưu trữ nào bây giờ  ? Lựa chọn lưu trữ phù hợp  không phải lúc nào cũng dễ dàng.  Tuy nhiên, với các nguồn lực và hướng dẫn phù hợp, điều đó sẽ trở nên dễ dàng hơn.  Trong bài đăng này, chúng tôi sẽ đề cập đến  Cloud Hosting  và những lợi ích của v...
Đọc thêm

Lợi ích của SAN ảo

  Đối với lưu trữ siêu hội tụ cho môi trường ảo hóa Virtual SAN (VSAN) về cơ bản là dễ dàng và cực kỳ đơn giản để triển khai và cung cấp.  Khách hàng có thể sử dụng đòn bẩy để lựa chọn tài nguyên tính toán và lưu trữ được chia sẻ và phân phối từ nền tảng X86 bằng cách sử dụng Cơ sở hạ tầng siêu hội tụ (HCI).  Ngoài ra Virtual SAN cho phép bạn mở rộng dung lượng lưu trữ ảo và tính toán tài nguyên theo yêu cầu. Trong bài đăng trên blog này, chúng tôi hướng đến sự đơn giản, nhanh nhẹn, khả năng quản lý và tiết kiệm chi phí khi sử dụng Virtual SAN >>>  Năm công cụ nguồn mở để phát triển web của bạn Sự đơn giản Như đã mô tả ở trên, VSAN rất đơn giản để cung cấp và quản lý, vẻ đẹp của VSAN là nó được tích hợp liền mạch trong trình siêu giám sát X86 và việc cài đặt, cấu hình và quản lý được thực hiện bằng một vài cú nhấp chuột từ ứng dụng web vSphere. Việc thêm các mảng hoặc ổ đĩa lưu trữ kết hợp bên ngoài vào bộ nhớ kết hợp của bạn là một quá trình rất phức tạp và...
Đọc thêm