The Most Beginner-Friendly Object Oriented Programming Tutorial Across the Network: 19 Python Implementation of Classes and Objects - Automatically Generating File Comments and function Comments with PyCharm
This article mainly introduces the method of automatically adding file comments when creating a new file in PyCharm, the IDE for Python, and also briefly presents the method of generating function comments in PyCharm.
This document mainly introduces how to use Python for Object Oriented programming, and requires readers to have a basic understanding of Python syntax and microcontroller development. Compared with other blogs or books that explain Python Object Oriented programming, this document is more detailed and focuses on embedded host computer applications, taking the common serial port data transmission and reception, data processing, dynamic graph drawing of host computer and slave computer as application examples, and uses Sourcetrail code software for visual code reading to facilitate readers' understanding.
The link to obtain the relevant sample code is as follows:
https://github.com/leezisheng/Python-OOP-Demo
Body Text
PyCharm provides a function to automatically generate file header comments when creating a new file, which can automatically generate necessary information such as the running environment, author, and date. It is easy to use and very simple to configure.
It can also automatically generate function comments, including parameters and return values. To use it, just directly enter three double quotes and press the Enter key when defining a function.