pycharm学习-2.py文件的开头注释

目录结构

1.写这篇博客的目的

2.py文件的开头注释的作用

3.py文件的开头注释的配置

 

 

 

1.写这篇博客的目的

主要记录：

1. py文件的开头注释有什么作用？
2. py文件的开头注释如何配置？

 

2.py文件的开头注释的作用

py文件，强烈建议都要写开头注释信息，这是良好的开发习惯，好的开头注释信息可以让自己和别人直观看出来py文件的相关基本信息；

 

3.py文件的开头注释的配置

完整操作流程可以看接下来的内容；

 

 参考的开头注释代码如下：

1.这是官方的开头注释代码(但我们实际开发过程中不会这样写)

# coding:utf-8
"""
@file: ${NAME}.py
@author: hjs
@ide: ${PRODUCT_NAME}
@createTime: ${YEAR}年${MONTH}月${DAY}日  ${HOUR}点${MINUTE}分
@contact: 727803257@qq.com
@Function: 请描述这个py文件的作用(范例：数据库语句代码操作)
"""

1.这是非官方的开头注释代码(我们实际开发过程中会这样写，我目前都是用这个)

# coding:utf-8
"""
@ide: ${PRODCUT_NAME}
@author: hjs
@contact: 727803257@qq.com
"""