全網最適合入門的物件導向程式設計教程：19 類和物件的 Python 實現-使用 PyCharm 自動生成檔案註釋和函式註釋
摘要：
本文主要介紹了在使用 Python 的 IDE-PyCharm 時，如何在新建檔案時自動新增檔案註釋的方法，同時對 PyCharm 中生成函式註釋的方法進行了簡單介紹。
原文連結：
FreakStudio的部落格
往期推薦：
學嵌入式的你，還不會物件導向？？！
全網最適合入門的物件導向程式設計教程：00 物件導向設計方法導論
全網最適合入門的物件導向程式設計教程：01 物件導向程式設計的基本概念
全網最適合入門的物件導向程式設計教程：02 類和物件的 Python 實現-使用 Python 建立類
全網最適合入門的物件導向程式設計教程：03 類和物件的 Python 實現-為自定義類新增屬性
全網最適合入門的物件導向程式設計教程：04 類和物件的Python實現-為自定義類新增方法
全網最適合入門的物件導向程式設計教程：05 類和物件的Python實現-PyCharm程式碼標籤
全網最適合入門的物件導向程式設計教程：06 類和物件的Python實現-自定義類的資料封裝
全網最適合入門的物件導向程式設計教程：07 類和物件的Python實現-型別註解
全網最適合入門的物件導向程式設計教程：08 類和物件的Python實現-@property裝飾器
全網最適合入門的物件導向程式設計教程：09 類和物件的Python實現-類之間的關係
全網最適合入門的物件導向程式設計教程：10 類和物件的Python實現-類的繼承和里氏替換原則
全網最適合入門的物件導向程式設計教程：11 類和物件的Python實現-子類呼叫父類方法
全網最適合入門的物件導向程式設計教程：12 類和物件的Python實現-Python使用logging模組輸出程式執行日誌
全網最適合入門的物件導向程式設計教程：13 類和物件的Python實現-視覺化閱讀程式碼神器Sourcetrail的安裝使用
全網最適合入門的物件導向程式設計教程：全網最適合入門的物件導向程式設計教程：14 類和物件的Python實現-類的靜態方法和類方法
全網最適合入門的物件導向程式設計教程：15 類和物件的 Python 實現-__slots__魔法方法
全網最適合入門的物件導向程式設計教程：16 類和物件的Python實現-多型、方法重寫與開閉原則
全網最適合入門的物件導向程式設計教程：17 類和物件的Python實現-鴨子型別與“file-like object“
全網最適合入門的物件導向程式設計教程：18 類和物件的Python實現-多重繼承與PyQtGraph串列埠資料繪製曲線圖
更多精彩內容可看：
給你的 Python 加加速：一文速通 Python 平行計算
一文搞懂 CM3 微控制器除錯原理
肝了半個月，嵌入式技術棧大彙總出爐
電子計算機類比賽的“武林秘籍”
一個MicroPython的開源專案集錦：awesome-micropython，包含各個方面的Micropython工具庫
文件和程式碼獲取：
可訪問如下連結進行對文件下載：
https://github.com/leezisheng/Doc
本文件主要介紹如何使用 Python 進行物件導向程式設計，需要讀者對 Python 語法和微控制器開發具有基本瞭解。相比其他講解 Python 物件導向程式設計的部落格或書籍而言，本文件更加詳細、側重於嵌入式上位機應用，以上位機和下位機的常見串列埠資料收發、資料處理、動態圖繪製等為應用例項，同時使用 Sourcetrail 程式碼軟體對程式碼進行視覺化閱讀便於讀者理解。
相關示例程式碼獲取連結如下：https://github.com/leezisheng/Python-OOP-Demo
正文
pycharm 提供了一個在新建檔案自動生成檔案頭註釋的功能，可以實現自動生成執行環境，作者、日期等必要資訊，使用比較方便，配置十分簡單。
_# Python env : _
_# -*- coding: utf-8 -*- _
_# __@Time__ : ${DATE} ${TIME} _
_# __@Author__ : 李清水 _
_# __@File__ : ${NAME}.py _
_# __@Description__ : _
同時可以自動生成函式註釋，包括引數和返回值。使用方法，函式定義時，直接輸入三個雙引號後回車。
