社攻联盟 - 大型多人在线游戏活动平台

社攻联盟 - 大型多人在线游戏活动平台

shape

Pycharm:自动生成注释、函数注释、注释模板、参数类型

  • Home
  • 公会基地
  • Pycharm:自动生成注释、函数注释、注释模板、参数类型
  • 2026-07-05 21:55:09
  • admin

1、# 单行注释

2、三引号 多行注释

'''

多行注释

'''

3、删除所有注释

CTRL+R进入替换模式,勾选右上角正则表达式,然后在搜索框输入 #.*,Replace All即可

4、自动为整个Python程序生成注释

学习自:Pycharm自动添加文件头注释和函数注释参数的方法_python_脚本之家

Settings→Editor→File and Code Templates→Python Scripts

Python Scripts建立完毕之后,会为每个新建的Python文件自动生成一个文件信息模板(在文件最前边),其中${XXX}表示的是一系列内置系统变量,例如项目名、文件名、用户名、时间、日期之类可以根据系统信息自动生成的值。

格式作用效果

${PROJECT_NAME}

项目名

${PRODUCT_NAME}

集成开发环境

${NAME}

文件名

${USER}

用户名(指登录电脑的那个用户名)

${DATE}

当前系统的年月日

${TIME}

当前系统的时分秒

${YEAR}

当前年份

${MONTH}

当前月份(形式:07)

${MONTH_NAME_SHORT}

当前月份(形式:7月)

${MONTH_NAME_FULL}

当前月份(形式:七月)

${DAY}

当天

${HOUR}

当前小时

${MINUTE}

当前分钟

${SECOND}

当前秒钟

5、为函数添加注释

在用def关键字新建函数之后,在后边一行加三引号,会自动补全六个引号。

在最中间的引号后换行,就会自动生成函数注释(有时显示indent expected,并且不自动生成注释,是因为缩进有问题,三点一定要从函数名后两格缩进处开始):

第1行:函数功能说明

第2~n-1行:参数介绍(注意冒号之后还有个空格)

第n行 return:返回值介绍

补全之后如下所示:

此时把鼠标指针移动到函数名处,按键CTRL+Q,就能显示这个函数的一系列信息:

此时可以看到a、b类型为Any,如果想要明确a、b的类型为int,返回值为int,可以写为:

def func1(a:int,b:int) ->int:

...

此时再把鼠标指针移动到函数名上(不管是定义还是使用时的函数名上),就可以同时看到参数类型和参数介绍了:

Previous Post
日本智能马桶盖哪个牌子好

Copyright © 2088 社攻联盟 - 大型多人在线游戏活动平台 All Rights Reserved.

友情链接