本章主要介绍Python中的文档,会通过多种方式来说明,如果查看Python自带文档和其他参考的资料

本章重点内容

1、#注释:源文件文档

2、dir函数:以列表显示对象中可用的属性

3、文档字符串 __doc__ :附加在对象上的源文件文档

4、PyDoc:help函数 交互式命令行中的对象帮助

5、PyDoc:HTML报告 浏览器中的模块文档

6、标准手册集:官方的语言和库描述

针对上面提到的重点,接下来详细说明

1、#注释:源文件文档

这是代码编辑中写文档的最基本方式,就是对某一行代码进行说明的注释,例如

这种注释,只有在源代码中能够看到

2、dir函数:以列表显示对象中可用的属性

通过内置的dir函数,可以抓取对象内所有可用属性列表,还是以简单的赋值对象为例,看赋值后的对象,有哪些属性

如果想知道有多少属性,可以通过len函数查看列表长度

通过查看可知,有70个,也就是一个简单的赋值语句后,系统会自动给该对象创建多个属性,其中很多属性就像内置的函数,可以直接使用,就拿第一个的“__abs__"来举例,具体代码示例如下:

在输入代码的过程中,有些代码编辑器是可以自动提升,提示的内容,就是该对象的属性和方法

继续用第一个属性,代码如下:

就是把对象取绝对值,之前是-1,取绝对值后就是1

3、文档字符串 __doc__ :附加在对象上的源文件文档

往往在写一段程序的开始,会先介绍该程序或者代码的作用和用途,使用方式,这些说明,会随着该程序封装在一起,一旦创建来对象,该说明会放在对象的“__doc__”属性中

就像上面刚刚看到过的赋值对象的属性,如果你有仔细看的话,是有该属性的,如下:

所以你会比较好奇,这个属性下面的内容是什么?让我们一探究竟:

通过以上代码,你会看到,我用三种方式查看__doc__的内容

第一种:是 .__doc__()的方式,想查看内容,但是系统提示错误无法查看,我的理解,因为doc不是方法,是属性,所以不用后面的(),直接使用即可

第二种:就是直接使用,.__doc__ 后面没有(),发现这次系统没有报错,打印出来来很多内容,这些内容就是系统自带的,对该对象使用方法的介绍,你看显示的内容,极其不宜阅读,因为它默认是不换行显示的,

第三种:就是通过print函数来显示,你会发现分段分行,很容易阅读,通过内容你可以了解到,这些都是来介绍该对象是如何使用的,就是介绍该对象的文档字符串

因为此处赋值的是-1,是整数,所以显示的文档是说明int,你可以自己动手试下赋值字符串后,会显示什么

4、PyDoc:help函数 交互式命令行中的对象帮助

help是我们熟知的查看文档说明的方式,因为方便快捷,同时易于理解,之前我不清楚的用法和属性,都是随时通过heip来查看了解的,还是承接上面的例子,通过heip查看,你会发现方便很多,而且内容要多的多,

以上只是截取的一部分,系统显示有241行

通过内容你会发现,这种方式更方便你了解该对象的所有信息

5、PyDoc:HTML报告 浏览器中的模块文档

HTML报告,通过浏览器查看,这个好像是只能在交互式方式中使用,在IDLE中会提示错误

以下是在交互命令行中进行的

6、标准手册集:官方的语言和库描述 

标准手册是安装python的时候自动有的资源,以我使用的IDLE,通过help选项卡查看

里面有一个选项:Python Docs,点击打开既是,打开后的效果如下:

是一个比较全面的说明,是官方标准的,很多内容都是最基本的

以上,就是本章讲解的文档查看的方式和资源,其实学习和了解文档,可以方便自己随时查看和学习,而且是系统自带的,会更加方便,这些文档和说明,如果利用得当,对自己的学习和了解,会有很大的帮助

《Python学习手册 第五版》 每章时间规划及完成进度:

2019.11.25-2019.12.01 第01章,已完成:《Python学习手册 第五版》 -第1章 问答环节

2019.12.02-2019.12.08 第02章,已完成:《Python学习手册 第五版》 -第2章 Python如何运行程序

2019.12.09-2019.12.15 第03章,已完成:《Python学习手册 第五版》 -第3章 你应如何运行Python程序

2019.12.16-2019.12.22 第04章,已完成:《Python学习手册 第五版》 -第4章 介绍Python对象类型

2019.12.23-2019.12.29 第05章,已完成:《Python学习手册 第五版》 -第5章 数值类型

2019.12.30-2020.01.05 第06章,已完成:《Python学习手册 第五版》 -第6章 动态类型

2020.01.06-2020.01.12 第07章,已完成:《Python学习手册 第五版》 -第7章 字符串基础

2020.01.12-2020.01.19 第08章,已完成:《Python学习手册 第五版》 -第8章 列表与字典

2020.01.20-2020.01.26 第09章,已完成:《Python学习手册 第五版》 -第9章 元组、文件与其他核心类型

2020.01.27-2020.02.02 第10章,已完成:《Python学习手册 第五版》 -第10章 Python语句简介

2020.02.03-2020.02.09 第11章,已完成:《Python学习手册 第五版》 -第11章 赋值、表达式和打印

2020.02.10-2020.02.16 第12章,已完成:《Python学习手册 第五版》 -第12章 if测试和语法规则

2020.02.17-2020.02.23 第13章,已完成:《Python学习手册 第五版》 -第13章 while循环和for循环

2020.02.24-2020.03.01 第14章,已完成:《Python学习手册 第五版》 -第14章 迭代和推导

2020.03.02-2020.03.08 第15章,已完成:

2020.03.09-2020.03.15 第16章,未完成

2020.03.16-2020.03.22 第17章,未完成

2020.03.23-2020.03.29 第18章,未完成

2020.03.30-2020.04.05 第19章,未完成

以下链接,可以供你了解这个学习笔记的所有章节最新进度

自学笔记系列:《Python学习手册 第五版》 -写在开始之前

《Python学习手册 第五版》 -第15章 文档的更多相关文章

  1. 《Python学习手册 第五版》 -第13章 while循环和for循环

    上一章已经讲过if条件语句,这章重点是循环语句:while.for 本章的重点内容 1.while循环 1)一般形式 2)break.continue.pass和循环的else 2.for循环 1)一 ...

  2. 《Python学习手册 第五版》 -第12章 if测试和语法规则

    本章节的内容,主要讲解if语句,if语句是三大复合语句之一(其他两个是while和for),能处理编程中大多数逻辑运算 本章的重点内容如下: 1.if语句的基本形式(多路分支) 2.布尔表达式 3.i ...

  3. 《Python学习手册 第五版》 -第11章 赋值、表达式和打印

    上一章对Python的语句和语法已经进行了基本的说明,接下来就是每个章节的详细说明,本章的主要内容就是标题中涵盖的三点:赋值语句.表达式语句.打印语句 本章重点内容如下: 1.赋值语句 1)赋值语句的 ...

  4. 《Python学习手册 第五版》 -第10章 Python语句简介

    前面在开始讲解数据类型的时候,有说过Python的知识结构,在此重温一下 Python知识结构: 程序由模块组成 模块包含语句 语句包含表达式 表达式创建并处理对象 关于知识结构,前面已经说过我自己的 ...

  5. 自学笔记系列:《Python学习手册 第五版》 -写在开始之前

    今年双十一,在当当网上买了这本书,很厚很厚的一本书,大概有将近1700页左右,的确是一个“大工程”, 关于这本书的学习,我想采用一种博客的方式进行,既是写给自己,也想分享给每一个对Python学习感兴 ...

  6. 《Python学习手册 第五版》 -第14章 迭代和推导

    承接上一章for循环的讲解,迭代和推导,是对for循环的一种深入的探索和扩展 本章重点内容 1.迭代 1)什么是迭代?都有哪些分类 2)常规的使用方法 3)多遍迭代器VS单遍迭代器 2.列表推导 1) ...

  7. 《Python学习手册 第五版》 -第18章 参数

    在函数的定义和调用中,参数是使用最多喝最频繁的,本章内容就是围绕函数的参数进行讲解 本章重点内容如下: 1.参数的传递 1)不可变得参数传递 2)可变得参数传递 2.参数的匹配模式 1)位置次序:从左 ...

  8. 《Python学习手册 第五版》 -第16章 函数基础

    前面的章节讲解的是一些基础数据类型.基本语句使用和一些文档查看的内容,这些都是一些基础,其实还谈不上入门,只有了解了函数,才算入门 函数是编程里面使用最多的也是最基本的程序结构, 本章重点内容 1.函 ...

  9. 《Python学习手册 第五版》 -第17章 作用域

    上一章的是函数的基础,因为函数在运用过程中,是可以嵌套的,函数中是会涉及到变量的,为了明确各自变量的使用范围,系统是有一套规则或者原则的,这就是作用域的概念 本章重点内容 1.作用域:作用域的概念 2 ...

随机推荐

  1. <s:url>指向的Action只执行一次,清除浏览器缓存文件后又可执行一次。

    Action中的方法仅为静态变量赋值,而其他访问数据库的Action可以被重复执行. 起初判断可能是静态变量的内存机制导致不能重复执行. 然后发现清楚浏览器缓存文件后又可以执行一次了,看来原因在Jsp ...

  2. 用手机地图GPS导航费流量吗?

    如果你的手机带有GPS芯片,那么使用手机导航是不会耗费手机流量的.但是如果你的手机没有GPS芯片,而使用的导航软件又是类似于移动提供的导航服务那样的导航功能,那就耗费手机流量了. 目前,导航软件导航主 ...

  3. 通过URl将服务器的图片下载到本地并压缩

    private void downloadServerPic(final String url1) { new Thread() { @Override public void run() { // ...

  4. Windows 7,64位机器上安装DB2 7.2+FP7

    1.要想在Windows 7,64位机器上安装DB2 7.2+FP7,注意:1)拷贝所有安装文件到本地2)设置setup.exe文件兼容windows 20003)使得users用户勾选“完全控制”权 ...

  5. 设计模式 之 Organizing the Catalog 组织目录

    Design patterns vary in their granularity and level of abstraction. Because thereare many design pat ...

  6. javascript原始值和对象引用

    一句话来说:原始值是不可变的,而对象引用是可变的. js中的原始值(undefined.null.布尔值.数字和字符串)与对象(包括数组和函数)有着本质的区别.原始值是不可更改的,任何方法都无法更改一 ...

  7. 简述layui前端ui框架的使用

    官方网址:https://www.layui.com/demo/upload.html

  8. [Swift]LeetCode241. 为运算表达式设计优先级 | Different Ways to Add Parentheses

    Given a string of numbers and operators, return all possible results from computing all the differen ...

  9. NIO ServerSocketChannel ScoketChannel

    package com.yb.nio; import java.io.IOException; import java.net.InetSocketAddress; import java.net.S ...

  10. 转载:2.2.2 配置项的语法格式《深入理解Nginx》(陶辉)

    原文:https://book.2cto.com/201304/19627.html 从上文的示例可以看出,最基本的配置项语法格式如下: 配置项名 配置项值1 配置项值2 - ; 下面解释一下配置项的 ...