Khi chúng ta bắt đầu năm 2020, tôi muốn bắt đầu quay lại một số nội dung yêu thích của mình. Nội dung Python “làm thế nào để”. Hôm nay, chúng ta sẽ xem cách bình luận mã trong Python—một kỹ năng mà tất cả chúng ta nên có
Tóm lại, có ba cách chính để đưa ra nhận xét trong Python. Để tạo nhận xét nội tuyến, hãy sử dụng dấu thăng, `#`python. Để tạo nhận xét nhiều dòng, hãy sử dụng dấu thăng trên mỗi dòng. Ngoài ra, hãy sử dụng ba dấu ngoặc kép, `”””`python. Chúng khởi động một chuỗi nhiều dòng có thể được sử dụng để mô phỏng nhận xét. Để biết thêm chi tiết, hãy xem các tùy chọn bên dưới
Mục lục
1 Tóm tắt video
2 Mô tả sự cố
3 Giải pháp
3. 1 Nhận xét nội tuyến
3. 2 Chặn nhận xét bằng nhận xét nội tuyến
3. 3 Chặn nhận xét bằng chuỗi nhiều dòng
4 Thử thách
5 Tóm tắt nhỏ
Video Tổng Hợp
https. //www. youtube. com/watch?v=O6WtQH62t6kKhông thể tải video vì JavaScript bị tắt. 3 cách để bình luận mã trong Python [https. //www. youtube. com/watch?v=O6WtQH62t6k]
Nếu video trên YouTube là sở thích của bạn, thì đây là video dài 9 phút bao gồm nhiều liên hệ tương tự như bài viết này. Mặc dù vậy, tôi có chia sẻ một cách ngắn gọn về lý do tại sao bạn có thể viết bình luận. Bám sát thử thách nơi bạn có thể chia sẻ suy nghĩ của riêng mình
Mô tả vấn đề
Một điều tôi đã làm trong suốt loạt bài này là tạo nội dung hướng đến một vấn đề cụ thể và giải quyết vấn đề đó bằng một vài giải pháp. Tất nhiên, nhiều giải pháp trong số đó yêu cầu một số hiểu biết cơ bản về cách thức hoạt động của Python. Nói cách khác, tôi chưa bao giờ thực sự viết bất kỳ bài báo cơ bản nào. Chà, tôi cho rằng muộn còn hơn không
Hôm nay, tôi muốn xem xét một số cách nhận xét mã trong Python. Đối với những người không biết, nhận xét là cách ghi lại mã trực tiếp. Cụ thể, nhận xét là văn bản không có ngữ nghĩa ảnh hưởng đến chương trình của bạn. Nói cách khác, bình luận không làm gì khác ngoài việc cung cấp ngữ cảnh cho người đọc
Ví dụ, chúng ta có thể muốn viết một số biểu thức toán học như Định lý Pythagore
a_squared = 3**2 b_squared = 4**2 c_squared = a_squared + b_squared
Rõ ràng, biểu thức này giống với Định lý Pythagore chỉ dựa trên các lựa chọn tên biến. Tuy nhiên, không phải ai cũng có thể nhận ra ngay từ cái nhìn đầu tiên. Nói cách khác, chúng tôi có thể muốn thêm một nhận xét cho người đọc biết mục đích của biểu thức này là gì. Ví dụ: chúng ta có thể nói “sử dụng Định lý Pythagore để tính c^2. Làm thế nào để chúng ta đi về làm điều đó?
Các giải pháp
Trong phần này của bài viết, chúng ta sẽ xem xét một vài cách khác nhau để viết bình luận trong Python. Hãy nhớ rằng đây không thực sự là một bài viết về phong cách bình luận hay thậm chí là một bài bình luận về cách viết bình luận. Thay vào đó, chúng tôi sẽ chỉ chia sẻ cú pháp. Việc tìm ra cách bạn muốn sử dụng các công cụ được cung cấp là tùy thuộc vào bạn.
Nhận xét nội tuyến
Trong Python, bạn có thể tạo nhận xét bằng cách sử dụng dấu thăng, `#`python. Ngay sau khi dấu này xuất hiện, mọi thứ theo sau nó cho đến cuối dòng được coi là nhận xét
# Uses the Pythagorean Theorem to compute c^2 a_squared = 3**2 b_squared = 4**2 c_squared = a_squared + b_squared
Vì các bình luận không bắt đầu cho đến khi dấu thăng xuất hiện, nên chúng tôi cũng có thể bình luận ở cuối dòng
# Uses the Pythagorean Theorem to compute c^2 a_squared = 3**2 # Computes a^2 b_squared = 4**2 # Computes b^2 c_squared = a_squared + b_squared # Computes c^2
Thông thường, tôi tin rằng mã của bạn chủ yếu là tự viết tài liệu. Điều đó nói rằng, một nhận xét nội tuyến ở đây và ở đó có thể hữu ích cho những người đọc trong tương lai — bao gồm cả bạn
Chặn bình luận bằng cách sử dụng bình luận nội tuyến
Sự thật thú vị. Python không có bình luận khối. Nói cách khác, không có cú pháp tích hợp để xử lý các nhận xét nhiều dòng. Do đó, PEP 8
# Uses the Pythagorean Theorem to compute c^2. # First, we compute a^2 and b^2. Then, the # expression is constructed as a^2 + b^2 and # assigned to c^2. a_squared = 3**2 # Computes a^2 b_squared = 4**2 # Computes b^2 c_squared = a_squared + b_squared # Computes c^2
Một lần nữa, những bình luận này có lẽ là quá mức;
Chặn nhận xét bằng cách sử dụng chuỗi nhiều dòng
Với tất cả những gì đã nói, có thể mô phỏng các nhận xét khối bằng các chuỗi nhiều dòng
""" Uses the Pythagorean Theorem to compute c^2. First, we compute a^2 and b^2. Then, the expression is constructed as a^2 + b^2 and assigned to c^2. """ a_squared = 3**2 # Computes a^2 b_squared = 4**2 # Computes b^2 c_squared = a_squared + b_squared # Computes c^2
Bây giờ, điều đó có vẻ sạch sẽ hơn đối với tôi. Ngoài ra, theo ý kiến của tôi, việc quản lý mã nguồn dễ dàng hơn một chút
Điều đó nói rằng, hãy nhớ rằng đây không phải là một nhận xét đúng. Thay vào đó, chúng tôi đã tạo một hằng chuỗi không được gán cho một biến. Trên thực tế, đây không thực sự là một vấn đề vì các chuỗi sẽ được tối ưu hóa trong mã byte
Một lời cảnh báo khác. đôi khi kiểu nhận xét này có thể được hiểu là một chuỗi tài liệu. Ví dụ: nếu chúng tôi chèn nhận xét này ngay bên dưới tiêu đề hàm, chúng tôi sẽ tạo một chuỗi tài liệu cho mục đích tài liệu
def pythagorean_theorem[a, b]: """ Computes the length of the squared third leg of a right triangle. """ a_squared = a**2 b_squared = b**2 c_squared = a_squared + b_squared return c_squared
Trong ví dụ này, nhận xét nhiều dòng của chúng tôi thực sự là một chuỗi tài liệu mà chúng tôi có thể sử dụng để ghi lại phương thức
def pythagorean_theorem[a, b]: """ Computes the length of the squared third leg of a right triangle. :param a: the length of the first leg of the triangle :param b: the length of the second leg of the triangle :return: a^2 + b^2 """ a_squared = a**2 b_squared = b**2 c_squared = a_squared + b_squared return c_squared
Sau đó, chuỗi tài liệu này trở thành thuộc tính thời gian chạy của hàm. Nói cách khác, chúng ta có thể kiểm tra thuộc tính đó như sau
print[pythagorean_theorem.__doc__]
Như bạn có thể thấy, chuỗi tài liệu không giống như nhận xét theo nghĩa là chuỗi tài liệu vẫn tồn tại trong thời gian chạy—các nhận xét thông thường thì không. Sau đó, nhiều IDE và các công cụ khác có thể trích xuất các chuỗi tài liệu này cho mục đích tài liệu. Làm thế nào là mát mẻ đó?
Thách đấu
Tại thời điểm này, tôi thường đo lường hiệu suất, nhưng tôi không cảm thấy cách đó có thể áp dụng được. Thay vào đó, hãy nhảy thẳng vào thử thách
Bây giờ chúng ta đã biết ba cách khác nhau để nhận xét mã trong Python, hãy nói về các phương pháp nhận xét tốt. Trên Twitter sử dụng #RenegadePython
Như mọi khi, tôi cũng sẽ chia sẻ mẹo của riêng mình trên Twitter
Đây là #RenegadePython cá nhân của tôi
mẹo để nhận xét mã. nhận xét chỉ nên nâng cao khả năng hiểu mã và không hơn thế nữa. Mặt khác, chúng thêm ít giá trị và có xu hướng trở thành cơn ác mộng để duy trì. – Jeremy Grifski [@ RenegadeCoder94] Ngày 10 tháng 8 năm 2020
Nếu có thể, tôi muốn thảo luận một chút. Tùy thuộc vào cách nó diễn ra, tôi có thể tổng hợp kết quả trong một bài viết khác
Tóm tắt một chút
Và với điều đó, tất cả chúng ta đã hoàn thành. Như mọi khi, đây là một bản tóm tắt nhỏ về ba cách của chúng tôi để nhận xét mã Python
________số 8Nếu bạn thích bài viết này và bạn muốn xem thêm bài viết tương tự, hãy truy cập danh sách gửi thư của tôi. Ngoài ra, bạn có thể đóng góp nhiều hơn nữa bằng cách trở thành người bảo trợ
Ngoài ra, bạn luôn có thể xem một số bài viết liên quan này
- Cách định dạng chuỗi trong Python
- Cách in trên cùng một dòng trong Python
- Cách lấy mục cuối cùng trong danh sách bằng Python
Nếu không, cảm ơn vì đã ghé qua. Tôi rât cảm kich
Cách sử dụng Python [41 bài viết]—Dòng điều hướngLoạt bài hướng dẫn Làm thế nào để Python khác với các bài viết viết mã chuyên sâu thông thường bằng cách khám phá các vấn đề có kích thước byte trong Python. Trong loạt bài này, học sinh sẽ đi sâu vào các chủ đề độc đáo như Cách đảo ngược từ điển, Cách tính tổng các phần tử của hai danh sách và Cách kiểm tra xem tệp có tồn tại không
Mỗi vấn đề được khám phá từ cách tiếp cận ngây thơ đến giải pháp lý tưởng. Thỉnh thoảng, cũng sẽ có một số giải pháp chỉ để cho vui. Ở cuối mỗi bài viết, bạn sẽ tìm thấy một bản tóm tắt đầy đủ các đoạn mã để bạn sử dụng. Đừng ngại lấy những gì bạn cần
Nếu bạn không chắc nên bắt đầu từ đâu, tôi khuyên bạn nên xem danh sách Đoạn mã Python cho các vấn đề hàng ngày của chúng tôi. Ngoài ra, bạn có thể tìm thấy một số đoạn trích ở định dạng sổ ghi chép Jupyter trên GitHub
Nếu bạn có một vấn đề của riêng bạn, xin vui lòng hỏi. Một người khác có thể có cùng một vấn đề. Thưởng thức cách sử dụng Python