Python中如何添加注释

Posted 2023-05-09

# 单行注释
'''多行注释
   多行注释
   多行注释
'''

参考技术A

1.单行注释

Python编程语言的单行注释常以#开头，单行注释可以作为单独的一行放在被注释代码行之上，也可以放在语句或者表达式之后。

实例：

# -*- coding: UTF-8 -*-

print("hello world!"); #您好，世界

2.多行注释

Python中多行注释使用三个单引号(’’’)或者三个双引号(”””)来标记，而实际上这是多行字符串的书写方式，并不是Python本身提倡的多行注释方法。

实例：

'''

这是多行注释，使用单引号。

这是多行注释，使用单引号。

'''

"""

这是多行注释，使用双引号。

这是多行注释，使用双引号。

"""

3.编码注释

在进行Python开发时，需进行编码声明，如采用UTF-8编码，需在源码上方进行# -*- coding:UTF-8
-*-声明，从Python3开始，Python默认使用UTF-8编码，所以Python3.x的源文件不需要特殊声明UTF-8编码。

4.平台注释

如果需要使Python程序运行在Windows平台上，需在Python文件的上方加上#!/usr/bin/python注释说明。

Pycharm在创建py文件时,如何自动添加文件头注释?

https://blog.csdn.net/imw_mg/article/details/77343284

 

PyCharm是一款很好用的编写Python工程的IDE，用PyCharm创建一个Python文件或者向工程添加一个.py文件时，为了更好的使所编写的代码在各操作环境更好的运行，我们往往需要在.py文件中添加头文件标注相关信息。例如：

指明在Linux环境中标注运行路径 
#!/usr/bin/env python

标注编码方式 
# -*- coding: utf-8 -*-

创建时间、作者、文件名等其他信息 
# @Time : ${DATE} ${TIME} 
# @Author : Aries 
# @Site : ${SITE} 
# @File : ${NAME}.py 
# @Software: ${PRODUCT_NAME}

打开PyCharm程序，根据菜单栏中按照如下进入设置：

File -> settings -> Editor -> File and Code Templates -> Python Script

找到Python Script选项，然后将一下内容添加进文本框即可：

#!/usr/bin/env python 
# -*- coding: utf-8 -*- 
# @Time : ${DATE} ${TIME} 
# @Author : Aries 
# @Site : ${SITE} 
# @File : ${NAME}.py 
# @Software: ${PRODUCT_NAME}
————————————————
版权声明：本文为CSDN博主「Leo-Woo」的原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/imw_mg/article/details/77343284