python开头添加自动注释

注释效果

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# @File  : function.py
# @Author: *******
# @Date  : 2019/1/5
# @Desc  :

解释注释含义

  • 第一行:#!/usr/bin/env python 针对linux系统,告诉操作系统和是用来说明脚本语言是python的,
    是要用/usr/bin下面的程序(工具)python,这个解释器,来解释python脚本,来运行python脚本的。
    • #!/usr/bin/python:是告诉操作系统执行这个脚本的时候,调用 /usr/bin 下的 python 解释器;
    • #!/usr/bin/env python(推荐):这种用法是为了防止操作系统用户没有将 python 装在默认的 /usr/bin 路径里。当系统看到这一行的时候,首先会到 env 设置里查找 python 的安装路径,再调用对应路径下的解释器程序完成操作。
    • #!/usr/bin/python 相当于写死了python路径;
    • #!/usr/bin/env python 会去环境设置寻找python目录,推荐这种写法
  • 第二行:# -- coding: utf-8 --
    表示代码以utf-8的格式保存
  • 后面的即字面意思

添加方法

File->Settings->Editor->Flie and Code Templates->python script

  • 格式
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# @File  : ${NAME}.py
# @Author: Your Name
# @Date  : ${DATE}
# @Desc  :
Logo

更多推荐