Pycharm自动添加文件头注释和函数注释参数

待我称王封你为后i 2022-12-11 15:03 273阅读 0赞

Pycharm应该是学python必用的编辑器了，关于它的使用之前已经写过几篇文章，今天再给大家继续介绍两个pycharm的小技巧，希望对大家有用。

**1.自动添加文件头注释**

### **文件头模板设置路径** ###

**Settings->Editor->File and Code Templates->Python Script**

在右侧箭头区域添加模板代码。

![format_png][]

#### 参考模板： ####

#!/usr/bin/env python
    # -*- coding: UTF-8 -*-
    '''
    @Project ：${PROJECT_NAME} 
    @File    ：${NAME}.py
    @Author  ：吾非同
    @Date    ：${DATE} ${TIME} 
    '''

**然后在pycharm中，新建python文件，自动添加文件头注释，效果如下：**

![format_png 1][]

#### 模板常用内置变量 ####

<table> 
 <thead> 
  <tr> 
   <th>格式</th> 
   <th>作用效果</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>${PROJECT_NAME}</td> 
   <td>项目名</td> 
  </tr> 
  <tr> 
   <td>${PRODUCT_NAME}</td> 
   <td>集成开发环境</td> 
  </tr> 
  <tr> 
   <td>${NAME}</td> 
   <td>文件名</td> 
  </tr> 
  <tr> 
   <td>${USER}</td> 
   <td>用户名（指登录电脑的那个用户名）</td> 
  </tr> 
  <tr> 
   <td>${DATE}</td> 
   <td>当前系统的年月日</td> 
  </tr> 
  <tr> 
   <td>${TIME}</td> 
   <td>当前系统的时分秒</td> 
  </tr> 
  <tr> 
   <td>${YEAR}</td> 
   <td>当前年份</td> 
  </tr> 
  <tr> 
   <td>${MONTH}</td> 
   <td>当前月份（形式：07）</td> 
  </tr> 
  <tr> 
   <td>${MONTH_NAME_SHORT}</td> 
   <td>当前月份（形式：7月）</td> 
  </tr> 
  <tr> 
   <td>${MONTH_NAME_FULL}</td> 
   <td>当前月份（形式：七月）</td> 
  </tr> 
  <tr> 
   <td>${DAY}</td> 
   <td>当天</td> 
  </tr> 
  <tr> 
   <td>${HOUR}</td> 
   <td>当前小时</td> 
  </tr> 
  <tr> 
   <td>${MINUTE}</td> 
   <td>当前分钟</td> 
  </tr> 
  <tr> 
   <td>${SECOND}</td> 
   <td>当前秒钟</td> 
  </tr> 
 </tbody> 
</table>

大家可以根据自己的喜好，设置一个专属的文件注释版本。

### **2.快速添加函数及参数注释** ###

在完成函数定义时，输入三个"""回车即可，自动添加函数注释参数。

![format_png 2][]

![format_png 3][]

编写好注释信息后，使用函数时，可以使用如下快捷键查看函数信息：

**mac：ctl+J**

**windows：ctrl+q**

![format_png 4][]

![format_png 5][]

好文章，我在看❤️

[format_png]: /images/20221123/78c58f2cd11f469eafc8416a597992ed.png
[format_png 1]: /images/20221123/5c2c66dc025a406ebf6f6e42d4272b97.png
[format_png 2]: /images/20221123/b9608f7fb4b949eda6d67427d757c61e.png
[format_png 3]: /images/20221123/80b3a38b88444e65953bb6fd1bbd5a08.png
[format_png 4]: /images/20221123/85f88334683d41f38bd375b2f2f98d2b.png
[format_png 5]: /images/20221123/e80a1560d5de438987720c532abb4605.png