Pycharm创建文件时自动生成文件头注释（自定义设置作者、日期等信息）

﹏ヽ暗。殇╰゛Y 2021-09-24 14:00 615阅读 0赞

有时候我们传.py文件给别人时，需要添加一些文件头注释。为了不用每次新建文件时都去手动添加作者、创建日期等信息，我们可以设置一套模板，在新建.py文件的时候自动使用这套模板。

### 文章目录 ###

*   *   *  一、 模板设置
         *   *  1.1 操作步骤
             *  1.2 参考变量
         *  二、 效果展示

### 一、 模板设置 ###

#### 1.1 操作步骤 ####

打开pycharm后，点击 *File* \--> *Settings* ，进入设置界面

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1MDY5Mjc5_size_16_color_FFFFFF_t_70]

点击 *Editor* \--> *File and Code Templates* \--> *Python Script*  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1MDY5Mjc5_size_16_color_FFFFFF_t_70 1]  
在右侧添加上你想注释的内容，如下图所示

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1MDY5Mjc5_size_16_color_FFFFFF_t_70 2]  
代码模板如下（可以根据自己需要进行修改）

#!/usr/bin/env python
    # -*- coding: UTF-8 -*-
    '''
    @Project ：${PROJECT_NAME} 
    @File    ：${NAME}.py
    @IDE     ：${PRODUCT_NAME} 
    @Author  ：苜苜的烂笔头
    @Date    ：${DATE} ${TIME} 
    '''

#### 1.2 参考变量 ####

预定义的变量格式为`${<variable_name>}`

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

### 二、 效果展示 ###

设置完后点击 *Apply* \--> *OK* ，新建后效果如下

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1MDY5Mjc5_size_16_color_FFFFFF_t_70 3]

好了，继续学习。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1MDY5Mjc5_size_16_color_FFFFFF_t_70]: /images/20210923/35210c6a9f914ea19650138885131c10.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1MDY5Mjc5_size_16_color_FFFFFF_t_70 1]: /images/20210923/06c8b4168afc4ba6af85c3d62164ee7f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1MDY5Mjc5_size_16_color_FFFFFF_t_70 2]: /images/20210923/aecd0aa6361a4c6f8cfe05e6b98b4f30.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1MDY5Mjc5_size_16_color_FFFFFF_t_70 3]: /images/20210923/f92aaae7d19949359e9d24c549788ffb.png