摘要：

本文主要介绍了在使用Python的IDE-PyCharm时，如何在新建文件时自动添加文件注释的方法，同时对PyCharm中生成函数注释的方法进行了简单介绍。

文档和代码获取：

本文档主要介绍如何使用 Python 进行面向对象编程，需要读者对 Python 语法和单片机开发具有基本了解。相比其他讲解 Python 面向对象编程的博客或书籍而言，本文档更加详细、侧重于嵌入式上位机应用，以上位机和下位机的常见串口数据收发、数据处理、动态图绘制等为应用实例，同时使用 Sourcetrail代码软件对代码进行可视化阅读便于读者理解。

正文

pycharm提供了一个在新建文件自动生成文件头注释的功能，可以实现自动生成运行环境，作者、日期等必要信息，使用比较方便，配置十分简单。

# Python env   : # -*- coding: utf-8 -*- # @Time : ${DATE} ${TIME} # @Author : 李清水 # @File : ${NAME}.py # @Description : 

同时可以自动生成函数注释，包括参数和返回值。使用方法，函数定义时，直接输入三个双引号后回车。