The usage and specification of single-line and multiline annotations in Pyhton

Source: Internet
Author: User
Preface

Annotations can play a role in a note, when the team is working together, personal code is often called by many people, in order to make it easier for others to understand the code of the thoroughfare, the use of annotations is very effective.

Python Comment Character

One, Python single-line comment sign (#)

The pound sign (#) is often used as a single-line comment symbol, and any data on its right will be ignored as a comment when using # in code.

Print 1 #输出1

#号右边的内容在执行的时候是不会被输出的.

Second, batch, multi-line comment symbol

In Python there are also many lines of comments, in which case you will need to bulk the multiline comment. Multiline comments are enclosed in three quotation marks "", for example:


Some people may say that this is not confused with multi-line string, but I see a lot of programmers are also so used, the use of attention to distinguish between the better.

Third, Python Chinese annotation method

When writing code in Python, you will not be able to avoid appearing or using Chinese, and you will need to add Chinese comments at the beginning of the file. If the beginning does not declare the format of the saved encoding, then it will default to use the Askii code to save the file, if you have Chinese in your code will be wrong, even if your Chinese is included in the comment. So it's important to add Chinese notes.

#coding =utf-8 or: #coding =GBK

Hint: Both of the above can represent Chinese comments, and more people I have seen using Urf-8.

Summarize

A good programmer, it is necessary to annotate the code. But make sure that the comments are important things, like a glance to know what to do, useless code does not need to add comments. The above is the entire content of this article, I hope the content of this article on everyone's study or work can bring some help.

  • Related Article

    Contact Us

    The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion; products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the content of the page makes you feel confusing, please write us an email, we will handle the problem within 5 days after receiving your email.

    If you find any instances of plagiarism from the community, please send an email to: info-contact@alibabacloud.com and provide relevant evidence. A staff member will contact you within 5 working days.

    A Free Trial That Lets You Build Big!

    Start building with 50+ products and up to 12 months usage for Elastic Compute Service

    • Sales Support

      1 on 1 presale consultation

    • After-Sales Support

      24/7 Technical Support 6 Free Tickets per Quarter Faster Response

    • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.