首页 > 脚本专栏 > python > 三个有引号不能自动生成函数注释

pycharm三个有引号不能自动生成函数注释的问题

2022-02-10 11:20:53 作者：li7

这篇文章主要介绍了解决pycharm三个有引号不能自动生成函数注释的问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教

pycharm三个有引号不能自动生成函数注释

函数注释

自动生成函数注释，包括参数和返回值。

使用方法，函数定义时，直接输入三个双引号后回车，例如：

    def add_script_flow(self, script_name, ip):
        """
        点击一个脚本命令图标，弹出参数配置框，选择脚本，输入执行ip和
        :param script_name: 脚本名称
        :param ip: 执行ip
        :return:
        """

突然发现，不能自动生成注释参数了

去File | Settings | Tools | Python Integrated Tools | Docstring format 这里改成你想要的格式，然后再回去看看你的三个引号。没有函数注释的情况下是plain。改成reStucturedText。

在这里插入图片描述

Python的三引号的用法

python中三引号可以将复杂的字符串进行复制

python三引号允许一个字符串跨多行，字符串中可以包含换行符、制表符以及其他特殊字符。
三引号的语法是一对连续的单引号或者双引号（通常都是成对的用）。

跨多行、换行符、制表符

chat = """how are you?
i'm fine, than you,and you?
    me too!"""
print(chat)

加注释

data = """name  # 姓名
age   # 年龄
sex   # 性别
"""
print(data)

多行注释

Python中的注释是用# ，但是#通常是单行注释，在注释有多行时，每一行多要写一个# ，而用""""""却可以一次性解决

"""
这是一个
多行注释
注释
"""
 
data = """name  # 姓名
age   # 年龄
sex   # 性别
"""
 
print(data)

sql语句：对于sql语句我们通常不建议用字符串拼接，而使用参数，在表达式中没有变量时，我们可以使用三引号来让sql语句更清晰

import pymysql
try:
    # 建立连接
    db = pymysql.connect(host='localhost', user='root', passwd='root', db='scraping')
    # 创建游标对象
    cur = db.cursor()
 
    # 新建表,三引号
    sql = """CREATE TABLE EMPLOYEE (
             FIRST_NAME  CHAR(20) NOT NULL,
             LAST_NAME  CHAR(20),
             AGE INT,
             SEX CHAR(1),
             INCOME FLOAT )"""
 
    cur.execute(sql)
 
finally:
    # 关闭数据库连接
    cur.close()

还有插入数据

import pymysql
try:
    # 建立连接
    db = pymysql.connect(host='localhost', user='root', passwd='root', db='scraping')
    # 创建游标对象
    cur = db.cursor()
    
    # SQL 插入语句
    sql = """INSERT INTO EMPLOYEE(FIRST_NAME,
             LAST_NAME, AGE, SEX, INCOME)
             VALUES ('Mac', 'Mohan', 20, 'M', 2000)"""
    try:
        # 执行sql语句
        cur.execute(sql)
        # 提交到数据库执行
        db.commit()
    except:
        # 如果发生错误则回滚
        db.rollback()
 
finally:
    # 关闭数据库连接
    cur.close()

如果使用单引号

import pymysql
try:
    # 建立连接
    db = pymysql.connect(host='localhost', user='root', passwd='root', db='scraping')
    # 创建游标对象
    cur = db.cursor()
 
    # SQL 插入语句
    sql = "INSERT INTO EMPLOYEE(FIRST_NAME, \
           LAST_NAME, AGE, SEX, INCOME) \
           VALUES ('%s', '%s', '%d', '%c', '%d' )" % \
          ('Mac', 'Mohan', 20, 'M', 2000)
 
    try:
        # 执行sql语句
        cur.execute(sql)
        # 提交到数据库执行
        db.commit()
    except:
        # 如果发生错误则回滚
        db.rollback()
 
finally:
    # 关闭数据库连接
    cur.close()

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。