网站域名如何备案信息,wordpress 耗时,网站备案 公司,app制作免费平台三个双引号的用于文件#xff0c;类#xff0c;函数注释。 没有统一的规定#xff0c;以下是比较清晰的写法。
文件注释#xff08;文件顶部#xff09;#xff1a;文件用途空行作者信息#xff08;每行一个键:值#xff09;
类注释#xff08;类名下行#xff09…三个双引号的用于文件类函数注释。 没有统一的规定以下是比较清晰的写法。
文件注释文件顶部文件用途空行作者信息每行一个键:值
类注释类名下行类用途空行 属性回车tab属性名属性类型属性描述 空行 方法回车tab方法名参数方法描述
函数注释函数名下行函数用途空行 参数回车tab参数名参数类型参数描述 空行 返回值回车tab返回类型返回值描述 空行 Raises可无: 回车tab异常类型异常描述 1. 文件注释
文件注释通常放在文件的顶部用于说明文件的用途、作者信息和其他基本信息。 This module provides utility functions for data processing.Author: John Doe
Email: john.doeexample.com
Date: 2025-01-22
import os
import numpy as np
2. 类注释
类的注释用于说明类的功能、用途以及主要属性和方法。
class MyClass:This class represents a simple example of a Python class.Attributes:attr1 (str): 属性1的描述attr2 (int): 属性2的描述Methods:method1(): 方法1的描述method2(param): 方法2的描述def __init__(self, attr1, attr2):self.attr1 attr1self.attr2 attr23. 函数注释
使用三引号 。包括以下部分 简要描述函数的总体用途。Args列出所有参数及其描述。Returns返回值及其类型。Raises可选列出可能引发的异常。
def add_numbers(a: int, b: int) - int:Adds two numbers and returns the result.Args:a (int): The first number.b (int): The second number.Returns:int: The sum of the two numbers.Raises:ValueError: If the input values are not integers.if not isinstance(a, int) or not isinstance(b, int):raise ValueError(Both inputs must be integers.)return a b4. 单行注释
x 42 # This is the answer to life, the universe, and everything5. 设置pycharm自动注释
对于文件注释和函数注释pycharm设置中有直接的相应设置。而对于类注释需要使用pycharm设置中的live templates间接实现同理也可以用于实现文件注释和函数注释。
文件注释
相当于是给对应格式的文件添加的比如说python文件。所以其设置在文件和代码模板中设置方法如下ctrlalts打开设置界面。 This module provides ______________Author: ${USER}
Email: 1345314460qq.com
Date: ${YEAR}-${MONTH}-${DAY}之后新建文件的时候注意不要选file, 要选Python File如下图。 类注释
live templates说白了就是根据你的缩写abbreviation 以及你设置的展开触发键Expand with), 进行展开为相应的内容Template text).
还是通过ctrlalts打开设置界面 This class _______Attributes:attr1 (str): 属性1的描述Methods:method1(param): 方法1的描述实际上缩写写成class不能被激活可能是因为表示注释这一部分就不被解析了。经测试class比较方便所以这里写为class, 其他和上图保持一致。之后点击define后勾选python下的class就只能在class范围激活. 测试一下输入class, 点击回车或tab键即可自动补全。注意写template text的时候不要有多余的缩进空格。 函数注释
函数注释不再是一个文件对应的模板其设置方法有所不同。在设置界面中tool下的python integrated tools中。 之后写完函数后在函数名下边打三个双引号回车就会自动补全。 over~
