Pycharm自定义文件头和函数注释

矫情吗；* 2024-05-24 02:13 54阅读 0赞

### 1、文件头注释 ###

按照这个顺序 File>settings>Editor>File and Templates>Python Script，找到文件和代码模板。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JhaWR1XzMzMjU2MTc0_size_16_color_FFFFFF_t_70]添加内容如下：

'''
    @File  :${NAME}.py
    @Author:YangMiao
    @Date  :${DATE}${TIME}
    @Desc  :
    '''

关于自定义函数模板参考这里：[参考链接][Link 1]

### 2、函数注释 ###

选择自己喜欢的风格，个人比较喜欢google的模板。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JhaWR1XzMzMjU2MTc0_size_16_color_FFFFFF_t_70 1]  
Google模板如下user函数所示，Epytext格式如user2函数所示，个人比较喜欢google的风格。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JhaWR1XzMzMjU2MTc0_size_16_color_FFFFFF_t_70 2]  
**注意：缩进，三引号 + Enter**

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JhaWR1XzMzMjU2MTc0_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/24/61836d4f7b4149ae8c9d743c4961a78f.png
[Link 1]: https://www.cnblogs.com/andy9468/p/8988501.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JhaWR1XzMzMjU2MTc0_size_16_color_FFFFFF_t_70 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/24/7b3f3d47308e4c0384646c0b989d7539.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JhaWR1XzMzMjU2MTc0_size_16_color_FFFFFF_t_70 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/24/7aebbf0290cd4e15aea5d79af5fbde89.png