Nhận xét nhiều dòng trong Python (2 tùy chọn khác nhau) • dữ liệu – python nhận xét nhiều dòng

Tìm hiểu cách sử dụng Python để thêm nhận xét nhiều dòng, cả bằng cách sử dụng các nhận xét đơn lẻ trên nhiều dòng và chuỗi nhiều dòng (không phải dưới dạng docstrings).

Bạn đang xem : python nhận xét nhiều dòng

Trong hướng dẫn này, bạn sẽ học cách sử dụng Python để tạo nhận xét nhiều dòng. Mặc dù bản thân Python không hỗ trợ nhận xét nhiều dòng, nhưng có hai tùy chọn cho phép bạn mở rộng nhận xét của mình qua nhiều dòng . Bạn tìm hiểu cách hoạt động của các bình luận Python và cách giữ cho chúng đi qua nhiều dòng. Bạn cũng sẽ học cách sử dụng chuỗi nhiều dòng để tạo nhận xét nhiều dòng.

Nhiều ngôn ngữ lập trình cung cấp các nhận xét nhiều dòng. Ví dụ: một số trong số chúng sẽ sử dụng ký hiệu / * comment * / giống như sau:

 / *
Đây là một
dòng bình luận trong
JavaScript
* / 

Rất tiếc, Python không cung cấp loại nhận xét này. Tuy nhiên, bạn có các tùy chọn để cho phép nhận xét của mình có nhiều luồng.

Câu trả lời nhanh: Sử dụng # để tạo nhận xét nhiều dòng bằng Python

Trả lời nhanh - Nhận xét đa dòng trong Python

Python cung cấp một tùy chọn duy nhất để tạo nhận xét, sử dụng dấu thăng, đôi khi được gọi là ký hiệu băm, # .

Nhận xét trong ngôn ngữ lập trình được sử dụng để giải thích mã và cung cấp ngữ cảnh. Họ thường giúp làm cho mã của bạn dễ đọc hơn bằng cách giải thích lý do tại sao mã của bạn (tức là tại sao bạn viết mã theo cách của bạn). Đôi khi, nhận xét cũng được sử dụng để ngăn không cho mã chạy và điều này thường được gọi là “mã nhận xét”.

Bạn có một số tùy chọn khác nhau về nơi bạn đặt biểu tượng bảng Anh:

  1. Nếu bạn đặt ký hiệu # ở đầu dòng, toàn bộ dòng sẽ trở thành chú thích
  2. Nếu bạn đặt mã # ở đâu đó dọc theo dòng mã, thì mọi thứ theo sau nó sẽ trở thành nhận xét

Hãy xem một vài ví dụ:

 # Tạo nhận xét bằng Python

# Thẻ bắt đầu bằng # duy nhất được sử dụng để tạo nhận xét một dòng bằng Python
a = 3 # Bạn có thể sử dụng chúng trong dòng để giải thích những gì bạn đang làm
# Đặt chúng ở phía trước, tuy nhiên, làm cho toàn bộ dòng trở thành một nhận xét 

Trong phần tiếp theo, bạn sẽ học cách sử dụng nhận xét một dòng để tạo nhận xét nhiều dòng bằng Python.

​​ Bạn muốn tìm hiểu thêm về cách hiểu danh sách Python? Hãy xem hướng dẫn chuyên sâu này bao gồm tất cả mọi thứ bạn cần biết, với các ví dụ thực tế. Nhiều người học bằng hình ảnh hơn, hãy xem hướng dẫn trên YouTube của tôi tại đây .

Mặc dù Python không hỗ trợ nhận xét nhiều dòng, bạn có thể sử dụng nhận xét một dòng để làm cho nhận xét của bạn kéo dài nhiều dòng. Những gì chúng tôi có thể làm để tạo một nhận xét có nhiều dòng chỉ đơn giản là nhận xét nhiều dòng.

Hãy xem điều này trông như thế nào trong Python:

 # Đây là nhận xét bắt đầu trên một dòng
# và tiếp tục tiếp tục
# và thậm chí có thể là một nữa 

Đây thực sự là phương pháp được đề xuất bởi Hướng dẫn kiểu PEP-8 của Python . Nó cũng đại diện cho cách "thực" duy nhất để tạo nhận xét bằng Python. Cách tiếp cận sau phần này không phải là nhận xét “thực sự” mà là một cách giải quyết.

Mặc dù có vẻ thực sự quá mức cần thiết khi phải bình luận nhiều dòng. Nhiều trình soạn thảo mã như VS Code cung cấp các phím tắt để thực hiện việc này. Ví dụ: trong VS Code, bạn có thể chỉ cần sử dụng CTRL + / hoặc CMD + / để nhận xét một dòng.

Học cách sử dụng các phím tắt này có thể giúp bạn dễ dàng thực hiện những công việc cảm thấy tẻ nhạt. Do đó, hoạt động này gần như trở thành tính chất thứ hai và điều này khiến việc tồn tại dễ dàng hơn khi thiếu các bình luận chính thức từ nhiều luồng ý kiến.

Trong phần tiếp theo, bạn sẽ học cách sử dụng chuỗi nhiều dòng trong Python không được gán cho các biến để mô phỏng các nhận xét nhiều dòng trong Python.

​​ Bạn muốn tìm hiểu cách sử dụng hàm Python zip () để lặp qua hai danh sách? Hướng dẫn này cho bạn chính xác chức năng của hàm zip () và chỉ cho bạn một số cách sáng tạo để sử dụng hàm.

Một cách đơn giản mà chúng ta có thể mô phỏng các nhận xét nhiều dòng trong Python là sử dụng các chuỗi nhiều dòng. Cách mà chúng tôi có thể tạo chuỗi kéo dài nhiều dòng là sử dụng dấu ngoặc kép ba, với dấu ngoặc kép đơn hoặc dấu ngoặc kép.

Hãy xem cách chúng ta có thể Python để tạo các chuỗi kéo dài nhiều dòng:

 a_multi_line_strin = '' '
đây là một chuỗi
kéo dài nhiều
dòng ''

another_multi_line_string = "" "
đây là cái khác
chuỗi kéo dài
nhiều dòng "" "

Một chuỗi thú vị về chuỗi Python là trình thông dịch Python bỏ qua bất kỳ chuỗi nào không được gán cho các biến, có nghĩa là chúng được coi gián tiếp dưới dạng nhận xét .

Đây không phải là các chuỗi tài liệu Python sao?

Bạn có thể nhận thấy rằng dấu ngoặc kép này trông rất giống với các chuỗi docstrings của Python. Chuỗi tài liệu được sử dụng để ghi lại một hàm và được tạo bằng cách sử dụng dấu ngoặc kép .

Khi bạn không tạo dấu ngoặc kép được thụt lề dưới dạng dòng đầu tiên của một hàm, chúng được coi là chuỗi đơn giản.

Hãy xem sự khác biệt trông như thế nào trong Python

 xác định một số_ hàm ():
    "" "Đây là docstrinfg
    để giải thích một hàm "" "

định nghĩa hàm khác ():
"" "Chuỗi tài liệu này sẽ báo lỗi
vì nó không được thụt lề đúng cách. "" "

some_string = "" "Đây là một chuỗi được gán
đến một biến và kéo dài nhiều dòng. "" "

"" "Bởi vì chuỗi này
không được gán cho một biến,
nó sẽ được coi là một dòng nhiều
nhận xét và sẽ bị bỏ qua. "" "

Bạn sẽ nhận thấy bốn trường hợp khác nhau ở trên:

  1. Một chuỗi tài liệu thích hợp, có thụt lề chính xác và tuân theo định nghĩa hàm
  2. Chuỗi tài liệu được thụt lề không đúng sẽ gây ra lỗi
  3. Một hàm nhiều dòng được gán cho một biến
  4. Một chuỗi nhiều dòng chưa được gán hoạt động giống như một nhận xét

​​Xem một số hướng dẫn Python khác về datagy, bao gồm hướng dẫn đầy đủ về tạo kiểu cho Gấu trúc tổng quan toàn diện của chúng tôi về Pivot Table in Pandas !

Kết luận

Trong hướng dẫn này, bạn đã học cách sử dụng Python để tạo nhận xét nhiều dòng. Mặc dù bản thân Python không có nhận xét nhiều dòng, nhưng bạn có thể tạo chúng bằng hai phương pháp khác nhau. Bạn đã học cách sử dụng Python để mở rộng các nhận xét đơn dòng qua nhiều dòng và cách sử dụng các chuỗi nhiều dòng để tạo nhận xét.

Nhận xét là công cụ vô cùng hữu ích trong lập trình. Chúng cho phép chúng tôi ghi lại mã, cung cấp sự hợp lý hóa về lý do tại sao chúng tôi làm mọi việc. Chúng cũng cho phép chúng tôi cung cấp giải thích về cách các đoạn mã phức tạp có thể hoạt động. Chúng cũng phục vụ một mục đích ngoài ý muốn là cho phép chúng tôi “bình luận” một số phần trong mã của chúng tôi. Điều này có nghĩa là lấy mã và biến nó thành các chú thích để nó không chạy khi chương trình được chạy.

Để tìm hiểu thêm về nhận xét bằng Python, hãy xem tài liệu chính thức tại đây .


Xem thêm những thông tin liên quan đến chủ đề python nhận xét nhiều dòng

Python Tutorial: Docstrings

alt

  • Tác giả: DataCamp
  • Ngày đăng: 2020-03-09
  • Đánh giá: 4 ⭐ ( 8226 lượt đánh giá )
  • Khớp với kết quả tìm kiếm: Want to learn more? Take the full course at https://learn.datacamp.com/courses/writing-functions-in-python at your own pace. More than a video, you'll learn hands-on coding & quickly apply skills to your daily work.

    ---

    Hi. My name is Shayne Miel. You've probably spent a lot of time using functions that someone else wrote. In this course, you'll learn how to write functions that others can use.

    Docstrings are a Python best practice that will make your code much easier to use, read, and maintain.

    Look at this split_and_stack() function. If you wanted to understand what the function does, what the arguments are supposed to be, and what it returns, you would have to spend some time deciphering the code.

    With a docstring though, it is much easier to tell what the expected inputs and outputs should be, as well as what the function does. This makes it easier for you and other engineers to use your code in the future.

    A docstring is a string written as the first line of a function. Because docstrings usually span multiple lines, they are enclosed in triple quotes, Python's way of writing multi-line strings. Every docstring has some (although usually not all) of these five key pieces of information: what the function does, what the arguments are, what the return value or values should be, info about any errors raised, and anything else you'd like to say about the function.

    Consistent style makes a project easier to read, and the Python community has evolved several standards for how to format your docstrings. Google-style and Numpydoc are the most popular formats, so we'll focus on those.

    In Google style, the docstring starts with a concise description of what the function does. This should be in an imperative language. For instance: "Split the data frame and stack the columns" instead of "This function will split the data frame and stack the columns".

    Next comes the "Args" section where you list each argument name, followed by its expected type in parentheses, and then what its role is in the function. If you need extra space, you can break to the next line and indent as I've done here. If an argument has a default value, mark it as "optional" when describing the type. If the function does not take any parameters, feel free to leave this section out.

    The next section is the "Returns" section, where you list the expected type or types of what gets returned. You can also provide some comments about what gets returned, but often the name of the function and the description will make this clear. Additional lines should not be indented.

    Finally, if your function intentionally raises any errors, you should add a "Raises" section. You can also include any additional notes or examples of usage in free form text at the end.

    The Numpydoc format is very similar and is the most common format in the scientific Python community. Personally, I think it looks better than the Google style. It takes up more vertical space though, so this course will either use Google-style or leave out the docstrings entirely to keep the examples compact and legible.

    Sometimes it is useful for your code to access the contents of your function's docstring. Every function in Python comes with a __doc__ attribute that holds this information.

    Notice that the __doc__ attribute contains the raw docstring, including any tabs or spaces that were added to make the words line up visually.

    To get a cleaner version, with those leading spaces removed, you can use the getdoc() function from the inspect module. The inspect module contains a lot of useful methods for gathering information about functions.

    Now it's your turn to practice writing and retrieving docstrings.

    DataCamp PythonTutorial WritingFunctionsinPython Docstrings

Làm thế nào để tôi nhận xét nhiều dòng trong máy tính xách tay Jupyter Ipython? [đóng cửa]

  • Tác giả: qastack.vn
  • Đánh giá: 3 ⭐ ( 3703 lượt đánh giá )
  • Khớp với kết quả tìm kiếm: [Tìm thấy giải pháp!] Ctrl+ /hoạt động với tôi trong trình duyệt Chrome trong MS Windows. Trên máy Mac, sử…

Nhận xét bằng Python

  • Tác giả: vi.tutorialcup.com
  • Đánh giá: 5 ⭐ ( 3024 lượt đánh giá )
  • Khớp với kết quả tìm kiếm: Bình luận Python không là gì khác ngoài một lời giải thích về mã nguồn của một chương trình. Nhận xét nên giải thích logic đằng sau mã, thay vì mã.

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

  • Tác giả: vi.softoban.com
  • Đánh giá: 4 ⭐ ( 7631 lượt đánh giá )
  • Khớp với kết quả tìm kiếm: Mọi ngôn ngữ lập trình đều cung cấp một cơ chế để thêm nhận xét vào các dự án. Viết nhận xét bằng Python có thể rất đơn giản và việc tạo nhận xét bằng Python bắt đầu bằng ký hiệu ‘#’. Bài viết này giải thích cách tạo nhận xét nhiều dòng trong Python.

Cú pháp Python

  • Tác giả: websitehcm.com
  • Đánh giá: 3 ⭐ ( 8763 lượt đánh giá )
  • Khớp với kết quả tìm kiếm: Cú pháp Python w3seo tìm hiểu về cấu trúc Python Syntax, cấu trúc về ngữ pháp của ngôn ngữ Python, các Syntax cơ bản python

Bài 5: Python3 : Cú pháp đơn giản

  • Tác giả: vncoder.vn
  • Đánh giá: 5 ⭐ ( 8276 lượt đánh giá )
  • Khớp với kết quả tìm kiếm: cú pháp đơn giản trong python, làm quen với python, các keyword trong python, các từ kháo trong python, cách đặt tên biến với python

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

  • Tác giả: pluginthanhtoan.com
  • Đánh giá: 3 ⭐ ( 6228 lượt đánh giá )
  • Khớp với kết quả tìm kiếm: botvietbai.com cung cấp các hướng dẫn, tài liệu tham khảo và bài tập trực tuyến miễn phí bằng tất cả các ngôn ngữ chính của web. Bao gồm các chủ đề phổ biến như HTML, CSS, JavaScript, Python, SQL, Java, và nhiều hơn nữa.

Xem thêm các bài viết khác thuộc chuyên mục: Kiến thức lập trình

Xem Thêm  Các biến JavaScript - biến sử dụng javascript trong hàm