配置pycharm工具的代码注释模板

最新推荐文章于 2024-09-21 23:11:13 发布

lyj_Jalone

最新推荐文章于 2024-09-21 23:11:13 发布

阅读量5.4k

点赞数 7

分类专栏： Python 文章标签： Python Pycharm

本文链接：https://blog.csdn.net/lyj_Jalone/article/details/103421302

版权

Python 专栏收录该内容

1 篇文章 1 订阅

订阅专栏

1、进入设置面板

ctrl + alt + s 快捷键：快速调出settings窗口。或点击菜单file-->setting进入。

2、设置模块的注释模板

Setting->Editor->File and Code Templates->Files->Python Script进入代码片段编辑界面。

python模块文件的注释模板：

"""
@FileName：${NAME}.py\n
@Description：\n
@Author：Jalone\n
@Time：${DATE} ${TIME}\n
@Department：研发部\n
@Website：www.xxx.com\n
@Copyright：©2019-${YEAR} xxx信息科技有限公司
"""

可用的模板变量有：

${PROJECT_NAME} - 当前项目的名称。

${NAME} - 在文件创建过程中在“新建文件”对话框中指定的新文件的名称。

${USER} - 当前用户的登录名。

${DATE} - 当前的系统日期。

${TIME} - 当前系统时间。

${YEAR} - 今年。

${MONTH} - 当月。

${DAY} - 当月的当天。

${HOUR} - 目前的小时。

${MINUTE} - 当前分钟。

${PRODUCT_NAME} - 将在其中创建文件的IDE的名称。

${MONTH_NAME_SHORT} - 月份名称的前3个字母。示例：1月，2月等

${MONTH_NAME_FULL} - 一个月的全名。示例：1月，2月等

3、设置类和方法的注释模板

ctrl + alt + s 快捷键：快速调出settings窗口。也可以file-》Setting-》Editor-》Live Templates-》Python》进入代码片段编辑界面

第4步新增时选择Live Template

1、设置类的注释模板：

第5步：breviation填写：clas

第6步：Description填写：def a Templet class

第7步：Template text填写：

class $NAME$():
    """
    @ClassName：$NAME$\n
    @Description：$END$\n
    @Author：Jalone
    """

2、设置方法的注释模板：

第5步：breviation填写：de

第6步：Description填写：def a Templet function1

第7步：Template text填写：

def $NAME$(self):
    """
    @Description：$END$\n
    """

打字不易，转载请说明出处，谢谢！