首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

使用python编写量子线路打印简单项目,并使用Sphinx自动化生成API文档

量子线路背景知识 在前面几篇博客,有介绍过使用开源量子计算编程框架ProjectQ进行量子线路绘制,会给我们输出一个tex格式线路图,在文章可以直接使用。...同时,为了展示API文档制作过程,这里我们在与函数都写了一部分示例注释代码,在下一个章节介绍一下文档效果。...我们先点击这里index和module看看内容,分别为下列两个图所示: ? ? 最后在这个索引列表我们点击进入qcprinter这个,去查看详细文档说明: ?...相应函数注释内容也会在接口文档中体现: ? 需要注意是,如果相关或者函数是受保护类型,那么在sphinx生成文档是不会显示(构造过程自动忽略)。...补充说明(2021.03.27) 如果在使用sphinx过程,发现代码注释文件并未被成功生成。

2.9K20
您找到你想要的搜索结果了吗?
是的
没有找到

Pocoo风格行为大赏

first', 'set of items', 'with more items', 'to come in this line', 'like this' ] 注意:为了保持美观,可以将链式调用每个方法前点...对齐;如果是括号换行,请将下一行与上一行括号对齐,不需要使用续行符号;如果字典、列表、元祖元素超级多,在起始括号后立即换行。...,混合使用双下划线。...如果使用关键字作为名称,那么在名称末尾添加下划线。与内置构件冲突是允许,请一定不要用 在变量名后添加下划线 方式解决冲突。...更多精彩文章请关注公众号『Pythonnote』或者『全栈技术精选』 3.1 函数和方法参数 1) 方法: cls 作为第一个参数 2) 实例方法: self 作为第一个参数 3) 用于属性 lambda

47210

Python文档字符串生成器:基于CodeBERT,支持Google、Numpy等多种输出格式

在训练过程使用 CodeSearchNet 语料库作为训练数据,并使用 CodeBERT Code2NL微调任务。 之后,进行推断基准测试如下: ?...从上图也能看出,在不同推断基准测试,所需要生成时间都很短(2s),这体现在操作上的话,就是延迟。...此外,还可以输出Google、docBlockr、Numpy、SphinxDocstring格式,PEP0257格式,也即将上线。...使用方法 1、从容器运行模型推断服务 具有GPU的话:在安装nvidia-docker后,运行docker run-it-d-GPU 0-p 5000:5000 gray kode/ai-docstring...2、在VSCode安装扩展并使用 光标必须在定义正下方行上,以生成完全自动填充文档字符串。

93820

Java面向对象特性总结

显示写了有参构造器,且没有无参构造器。子类继承时候必须显示调用有参构造器。调用方式可以使用super(a,b)来调用。...子类对象实例化过程 new出一个子类对象时候,必须先new出一个对象。子类在调用构造方法时,会先调用构造方法。(默认) 如果写构造方法,编译器默认加上一个无参构造器。...如果在声明使用extends关键字指明其父,则默认 为java.lang.Object(任何都可以调用Object方法) package java.lang; public class...除此之外任何地方 都不能使用该类 但是它对象可以通过外部方法返回值返回使用,返回值类型只能是局部内部类 接口类型 局部内部类可以使用外部方法局部变量,但是必须是final。...如果一个方法抛出异常,该异常对象会被抛给调用者方法处 理。如果异常没有在调用者方法处理,它继续被抛给这个调用 方法上层方法。这个过程将一直继续下去,直到异常被处理。

46310

2021 年 Python 程序员必备 VS code 插件!

除了语法高亮显示,Python还有一个强大功能,如: IntelliSense:使用自动补全、代码导航、语法检查等功能编写代码 Linting:使用Pylint、flke8等获得额外代码分析 代码格式...列表、集合、元组、字典、等等。...使用这个插件另一个好处是,它还为每个代码片段提供了至少一个示例,使它在学习Python时很有用。 3、Python Docstring Generator ?...文档重要性相信大家都知道,Python Docstring Generator通过自动创建文档字符串,大大减少了开发人员工作量,关于这个扩展最好事情是它遵循docstring所有标准格式,包括谷歌...此外,它还可以在工作区搜索 Python 文件以进行类型估计。 ? 7、jupiter ? jupiter是我最喜欢VS Code扩展之一。

1.7K20

Java匹马行天下之JavaSE核心技术——面向对象

在Java编程,我们使用成员变量表示数据模型,用成员方法表示行为模型。             使用表示某些具有相同属性和行为事物。 1....default (即缺省,什么也写): 在同一包可见,不使用任何修饰符。使用对象:、接口、变量、方法。 private : 在同一可见。使用对象:变量、方法。 ...注意:不能修饰(外部类) public : 对所有可见。使用对象:、接口、变量、方法 protected : 对同一包和所有子类可见。使用对象:变量、方法。 ...,那么子类需要要重写所有抽象所有抽象方法; 抽象也可以继承非抽象,同时继承了所有非私有的属性和方法; 实例 abstract class Caravan{ private...; 子类重写方法,子类对象调用是子类重写后方法; 使用static修饰方法不能被重写,但是可以被子类重写声明; 不同包子类可以重写protected修饰方法,但是不能以继承形式

78530

Java匹马行天下之JavaSE核心技术——面向对象

在Java编程,我们使用成员变量表示数据模型,用成员方法表示行为模型。使用表示某些具有相同属性和行为事物。...Java 支持 4 种不同访问权限。 default (即缺省,什么也写): 在同一包可见,不使用任何修饰符。使用对象:、接口、变量、方法。 private : 在同一可见。...使用对象:变量、方法。 注意:不能修饰(外部类) public : 对所有可见。使用对象:、接口、变量、方法 protected : 对同一包和所有子类可见。使用对象:变量、方法。...引用指向子类对象、匿名内部类; 子类必须重写抽象所有抽象方法,或者是把子类也定义为抽象; 如果一个继承抽象还有上级抽象,那么子类需要要重写所有抽象所有抽象方法; 抽象也可以继承非抽象...,子类对象调用是子类重写后方法; 使用static修饰方法不能被重写,但是可以被子类重写声明; 不同包子类可以重写protected修饰方法,但是不能以继承形式,用子类对象直接调用该方法

44830

用 VS Code 写 Python,这几个插件是必装

并且,生成文档字符串遵循所有标准格式,包括Google、docBlockr、Numpy、Sphinx和PEP0257。...它主要功能包括: 快速生成一个可通过Tab键浏览docstring代码段 在几种不同类型文档字符串格式之间进行选择 通过pep484型提示、默认值和var名称推断参数类型 支持args,kwargs...具体功能如下: 在VS Code侧栏“测试”视图中显示“测试资源管理器”,其中包含所有检测到测试、套件及其状态 在测试发现期间方便错误报告 单元测试和Pytest调试 在资源管理器中选择测试后...,显示失败测试日志 支持多根工作区 支持Unittest和Pytest测试框架及其插件 ?...Jupyter可以说是我最喜欢VS Code插件之一,可以让我们在VS Code完美使用Jupyter Notebooks。

29.3K21

JAVA入门2 原

1.2定义java ? ? ? ? 定义首字母要大写 ? ? 1.3使用java对象 ? ? 经常把属性称为实例变量 ? ? ? ? 默认值是0 ? ? ? 1.4成员变量,局部变量 ?...、 protected 、 private 等 2、 Inner 定义 test() 方法可以直接访问 Outer 数据,而不受访问控制符影响,如直接访问 Outer 私有属性a 3...,方法内部类只在该方法内部可见,即只在该方法可以使用。...main里调用属性 ? main调用方法 ? main调用子类方法 ? ? 无参构造方法 ? 子类无参构造方法,隐式显示 ? ? 会自动执行构造方法 ? ? ?...子类没有显示调用构造方法 ? 定义一个有参构造方法 ? 报错 ? 3.6javaobject ? ? ? ? ? ? 包名+地址 ?

37410

【Java零基础入门篇】第 ④ 期 - 继承(二)

例如访问成员变量、成员方法和构造方法。 可以在子类方法或构造方法,通过“super.属性”或”super.方法”方式,显式调用声明属性或方法。...在Java使用super来调用指定操作: super可用于访问定义属性(成员变量); super可用于调用定义成员方法; super可用于在子类构造器调用构造器; 调用构造方法...,那么在子类构造器首行,没有显示声明”super(形参列表)”,默认调用中空参构造器:super(); 注意: 当子出现同名成员时,可以用super表明调用成员; super...用来保护对、变量、方法和构造方法访问。 public : 对所有可见。使用对象:、接口、变量、方法; default (即默认,什么也写): 在同一包可见,不使用任何修饰符。...**使用对象:**、接口、变量、方法; protected: 对同一包和所有子类可见。使用对象:变量、方法。 注意:不能修饰(外部类); private : 在同一可见。

10810

【Java SE学习】Day6 JavaSE面向对象(下)看着三篇就够了

非静态方法,既可以调用非静态方法或属性,也可以调用静态方法或属性 static注意点: 在静态方法,不能使用this关键字、super关键字 关于静态属性和静态方法使用,大家都从生命周期角度去理解...如何判定属性和方法应该使用static关键字: 关于属性属性是可以被多个对象所共享,不会随着对象不同而不同常量也常常声明为static 关于方法。...作用:可以在创建对象时,对对象属性等进行初始化 如果一个定义了多个非静态代码块,则按照声明先后顺序执行 非静态代码块可以调用静态属性、静态方法,或非静态属性、非静态方法 注意:实例化子类对象时...,涉及到、子类静态代码块、非静态代码块、构造器加载顺序: 由及子,静态先行。...如果实现重写了接口中默认方法,调用时,仍然调用是重写以后方法 知识点3:如果子类(或实现)继承和实现接口中声明了同名同参数默认方法,那么子类在没重写此方法情况下,默认调用同名同参数方法

37130

-1-2 java 面向对象基本概念 封装继承多态 变量 this super static 静态变量 匿名对象 值传递 初始化过程 代码块 final关键字 抽象 接口 区别 多态

:是一组相关属性和行为集合 对象:是该类事物具体体现 成员变量与局部变量 在位置不同   •成员变量 中方法外   •局部变量 方法或者方法声明上 在内存位置不同   •成员变量...多个可以称为子类,单独这个称为或者超。 子类可以直接访问非私有的属性和行为。 通过extends 关键字让之间产生继承关系。   ...super代表内存空间标识。 当子出现同名成员时,可以用super进行区分 子类要调用构造函数时,可以使用super语句。...一个程序文件只有一个package,可以有多个import。 用来导包导入包包。 内部类 将一个定义在另一个里面,对里面那个就称为内部类(内置,嵌套)。...•同时可以访问所在局部局部变量,但必须是被final修饰。 内部类访问外部类属性部类名称.this.属性名 匿名内部类 就是内部类简化写法。

67310

python 开发规范 预览版

111' 空格规则 单目运算符与运算对象之间空格(例如,-,~等),即使单目运算符位于括号内部也一样。...预编译正则表达式:name_re。 受保护元素以一个下划线为前缀。双下划线前缀只有定义混入(mixin classes)时才使用。...命名要有寓意, 不使用拼音,不使用无意义简单字母命名 (循环中计数例外 for i in) 命名缩写要谨慎, 尽量是大家认可缩写 尽量 避免使用全局变量, 用变量来代替 函数和方法参数: 方法:...禁止参数里面 直接写 字符id,用其他替代,例如 asset_id 文档注释(Docstring,即各方法,说明文档注释) 所有文档字符串均以 reStructuredText 格式编写,方便 Sphinx...如果为多行,文档字符串文本紧接着代表字符串开始三个引号编写,代表字符串结束三个引号则自己独立成一行。

69360

Java面向对象三大特性详解「建议收藏」

3.当getter和setter函数参数名和成员函数名重合时候,可以使用this区别。如: C、Java 部类部类( Inner Class )就是定义在另外一个里面的。...B、继承初始化顺序 1、初始化再初始化子类 2、先执行初始化对象属性,再执行构造方法初始化。...其实这个过程已经隐式地使用了我们super关键字。 这是因为如果子类构造方法没有显示调用构造方法,则系统默认调用无参构造方法。...那么如果自己用super关键字在子类里调用构造方法,则必须在子类构造方法第一行。 要注意是:如果子类构造方法既没有显示调用构造方法,而没有无参构造方法,则编译出错。...12 } 13 } 运行结果: 4.接口和匿名内部类配合使用 接口在使用过程还经常和匿名内部类配合使用

50020

赶在 520 之前给您来份 Java 面向对象小抄

变量声明 1.1.1. 实例成员变量 这种是实例成员变量声明,声明变量在都可以使用。可以声明类型包括:整型、浮点型、字符型、逻辑类型、数组、对象、接口等。...2.1.4. default --- 可修饰 同一个包方法都能访问该成员,可以省略写。 2.1.5....在内部类需要注意以下几点: 如果成员域具有 static 属性,那么必须要有 final 属性,即 final static; 不能含有 static 属性成员方法; 创建该内部类对象实例时,需要先创建外部类对象...; 不能具有抽象方法或属性,不能有 static 属性成员变量和方法(假如成员变量具有 static 属性,那么必须要有 final 属性); 匿名实例对象方法,通过它类型引用变量来访问。...Printable, Addable {} 实现了某接口,子类自然也是实现了该接口,因此子类不必再显示使用 implements 声明实现了这个接口。

62120

来了来了它来了,100条必背JAVA知识点(下)

②特殊情况:当子类和定义了同名属性时,要想在子类调用声明属性,则必须显式使用"super.属性"方式,表明调用声明属性。...②静态方法,只能调用静态方法或属性。非静态方法,既可以调用非静态方法或属性,也可以调用静态方法或属性。 70、在静态方法,不能使用this关键字、super关键字(生命周期)。...,对对象属性等进行初始化 ⑤如果一个定义了多个非静态代码块,则按照声明先后顺序执行 ⑥非静态代码块可以调用静态属性、静态方法,或非静态属性、非静态方法 74、实例化子类对象时,涉及到...⑤如何在子类(或实现)方法调用、接口中被重写方法。 86、内部类分类:成员内部类(静态、非静态 )、局部内部类(方法、代码块、构造器)。...87、成员内部类理解: ①一方面,作为外部类成员 调用外部类结构 可以被static修饰 可以被4种不同权限修饰 ②另一方面,作为一个 可以定义属性、方法、构造器等 可以被final修饰,

65810

Java入门必背100条

局部变量:声明在方法、方法形参、代码块、构造器形参、构造器内部变量 ② 关于权限修饰符不同 属性:可以在声明属性时,指明其权限,使用权限修饰符。...②特殊情况:当子类和定义了同名属性时,要想在子类调用声明属性,则必须显式使用”super.属性方式,表明调用声明属性。...②静态方法,只能调用静态方法或属性。非静态方法,既可以调用非静态方法或属性,也可以调用静态方法或属性。 75、在静态方法,不能使用this关键字、super关键字(生命周期)。...,对对象属性等进行初始化 如果一个定义了多个非静态代码块,则按照声明先后顺序执行 非静态代码块可以调用静态属性、静态方法,或非静态属性、非静态方法 79、实例化子类对象时,涉及到...91、成员内部类理解: 一方面,作为外部类成员 调用外部类结构 可以被static修饰 可以被4种不同权限修饰 另一方面,作为一个可以定义属性、方法、构造器等 可以被final

1K20

一篇文章讲清楚Java面向对象三大特性(基础篇)

万物皆对象,对象是具体世界事物,面向对象三大特征封装,继承,多态,封装,封装说明一个行为和属性与其他关系,低耦合,高聚;继承是和子类关系,多态说关系。...例如定义一个语文老师和数学老师,如果采用继承方式,那么两个需要定义属性和方法如图 1 所示。 ?...使用这种层次形分类方式,是为了将多个通用属性和方法提取出来,放在它们,然后只需要在子类各自定义自己独有的属性和方法,并以继承形式在获取它们通用属性和方法即可。  ...其实这个过程已经隐式地使用了我们super关键字。  这是因为如果子类构造方法没有显示调用构造方法,则系统默认调用无参构造方法。  ...那么如果自己用super关键字在子类里调用构造方法,则必须在子类构造方法第一行。 要注意是:如果子类构造方法既没有显示调用构造方法,而没有无参构造方法,则编译出错。

1.1K30

JVM-9.Class文件结构

索引用于确定这个全限定名 索引用于确认这个全限定名 除了java.lang.Object之外Java都有,因此除了它之外所有Java索引都不为0 接口索引描述了实现接口按...在descriptor_index之后都跟随者一个属性列表集合用于存储额外信息 字段表不会列出从超或者接口中继承来字段,但可能列出自动添加额外字段 ?...属性表结构 8.1 Code属性 方法体经过javac编译后,变成字节码存储在Code属性 Code属性出现在方法表属性集合,接口或抽象方法没有Code属性 Code属性表结构:...,默认生成,取消后抛出异常时堆栈无法显示出错行号。...,标识推荐使用 Synthetic:标识字段,方法不是Java源码,是编译器自动生成 结构都是: ?

74640

扫码

添加站长 进交流群

领取专属 10元无门槛券

手把手带您无忧上云

扫码加入开发者社群

相关资讯

热门标签

活动推荐

    运营活动

    活动名称
    广告关闭
    领券