Python 开发工具 Pycharm —— 使用技巧Lv.2

简介: 例子2:方法内使用#号注释,pydoc不会显示注释内容(class同理)

pydoc是python自带的一个文档生成工具,使用pydoc可以很方便的查看类和方法结构


本文主要介绍:1.查看文档的方法、2.html文档说明、3.注释方法、


一、查看文档的方法

**方法1:**启动本地服务,在web上查看文档

命令【python3 -m pydoc -p 1234】


通过http://localhost:1234来访问查看文档

64439e80149941254af3701e996088d6_ea2718a22a384ab53d01bf84da93125c.png



说明:


1、-p指定启动的服务的端口号,可以随意指定不冲突的端口号


2、只有在自建的工程根目录下使用该命令,才能看到当前工程下所有的内容,否则只能看到python环境变量下的模块内容


3、如果本地只有一个python,可以直接使用【pydoc -p 端口号】启动,但因为我本地有python2和python3,所以指定了用python3


**方法2:**直接查看某个py文件的内容

例子:新建了一个py文件叫做testpydoc.py,进入testpydoc.py所在目录


python3 -m pydoc testpydoc

81d746051a0e520f68dce97a42b63643_1c4ea28761dddf5dc264e9a08de2e6fd.png



**方法三:**生成html说明文档

例子:新建了一个py文件叫做testpydoc.py,进入testpydoc.py所在目录


python3 -m pydoc -w testpydoc


会默认将当前目录下的testpydoc生成一个叫做testpydoc.html的文档,如果是目录直接【python3 -m pydoc -w 目录名】生成文档


说明:如果是将整个目录生成这种格式,不建议用这种方式,因为如果他展示目录下的子文件的说明时,会去子目录下找对应.html文件,如果文件不存在,就会404

b0f7a691d2b7c107b8db6726ee602dc0_5cb6c66aa25cfceb53579fa08614d85c.png



方法四:-k查找模块

py通过-k查找模块,会在当前工程目录以及python环境变量目录下查找包含关键词的模块信息


【python3 -m pydoc -k 关键词】


例如如下命令:


python3 -m pydoc -k testpydoc


结果如下:


testpydoc - @author 每天1990


二、html文档说明

通过查看文档的方法,我们可以看到在html的文档主要分成四部分:py文件的顶部注释、Classes、Functions、Data


(示例代码见结尾部分)


第一部分:模块的文档说明,展示模块顶部的多行注释

注释内如果包含了模块文件内的class名,或方法名(),则显示蓝色,且可以点击跳转到对应说明位置


c5d8341e8cc0f985964881d95cab925f_3e5f1674b646728f43d6db6e4652d8f1.png


第二部分:classes,展示class以及class下的function

1.只能展示class下的注释,不会展示class下方法的注释


2.class上面有#注释时,展示#号的注释


3.class下有”””多行注释”””时优先展示多行注释,就不展示顶部的#号的注释了


第三部分:function,模块下的def方法,不是class中的方法

1.function上面有#注释时,展示#号的注释


2.function下有”””多行注释”””时优先展示多行注释,就不展示顶部的#号的注释了

63403c35574c766ab7988d2272d98668_a773a2be5db8673accdd6b1b5affa02b.png



第四部分:data,模块下直接定义的变量,不是function或class的变量



示例代码:


“”"

@author 每天1990

@desc 本模块是一个测试文件,用来说明pydoc的读取内容

@date 2017/4/13

说明:

classes:testclass(),具有function1()和function2()两个方法


function:test1(),test2(),test3()


Data:a,b

“”"


#注释放在方法名前,使用#号注释

def test1(a):

print(“注释放在方法名前”)


#注释放在方法名前,使用#号注释

def test2():

“”"

注释放在方法内的第一行,既有#号又有多行注释时,优先展示多行注释

“”"

print("既有#号又有多行注释时,优先展示多行注释 ")


def test3():

#在方法第一行内使用#注释

print(“在方法内使用#号注释,不生效”)


class testclass():

“”"

注释生效顺序与方法一致,优先展示类下的多行注释,如果没有才展示类上面的#号注释

类下的方法的注释不会展示出来

“”"

def function1(self):#类下方法的注释不会展示

print(“类下的第一个方法”)

def function2(self,a):

print(“类下的第二个参数,包含a参数”)


a=1#变量的注释不会展示出来

b=2


三、注释方法

通过上面的文档说明,我们可以合理的注释,有助于了解工程结构


python的注释方法有两种:

1.单行注释:使用#号进行注释


#单行注释


2.多行注释:使用三个双引号或单引号来注释多行内容


‘’’

单引号进行多行注释


‘’’


“”"


双引号进行多行注释


“”"


pydoc注释展示策略:

在functions和classes前面加#注释,或者在function和class第一行内加三个单引号或三个双引号进行注释


如果有三个引号的注释方法,会优先使用三个点的注释,其次才展示#号的注释


注意:如果在方法或class定义后第一行使用#注释是拉取不到注释的


例子1:class前有#号注释,class内有多行注释,pydoc会优先展示三个点内的注释


22a13c59af6aa3e222217676eab9a743_19f8808494c23e8630d606c4745a046e.png


例子2:方法内使用#号注释,pydoc不会显示注释内容(class同理)


61fe87e952f43166fa02b504853dbed2_cec6933756c7e2f78e36d9c720b8053b.png


例子3:方法或class没有多行注释,只在方法外有#号注释时,会展示定义前的#号内的内容


8255014950c79bbe7226ea15a69cbdf1_690a759279aa398cd093cb6c5cb4295f.png


例子4:模块顶部的内容,优先展示多行注释中的内容

目录
相关文章
|
2月前
|
Java UED Python
【10月更文挑战第4天】「Mac上学Python 4」入门篇4 - PyCharm高效开发环境配置与使用技巧
本篇将详细介绍如何高效地使用PyCharm进行Python开发,内容涵盖PyCharm的主题设置、字体调整、常用快捷键、虚拟环境的管理、库安装与调试技巧等。通过本篇的学习,用户将能够充分利用PyCharm的功能,提升Python开发效率。
149 2
【10月更文挑战第4天】「Mac上学Python 4」入门篇4 - PyCharm高效开发环境配置与使用技巧
|
2月前
|
IDE 网络安全 开发工具
IDE之pycharm:专业版本连接远程服务器代码,并配置远程python环境解释器(亲测OK)。
本文介绍了如何在PyCharm专业版中连接远程服务器并配置远程Python环境解释器,以便在服务器上运行代码。
377 0
IDE之pycharm:专业版本连接远程服务器代码,并配置远程python环境解释器(亲测OK)。
|
3月前
|
Python Windows
安装python 以及 安装 pycharm
安装python 以及 安装 pycharm
|
4月前
|
开发工具 Python Windows
【Python专栏】搭建Pyhthon运行环境及开发环境 | 安装Python | 安装PyCharm
【Python专栏】搭建Pyhthon运行环境及开发环境 | 安装Python | 安装PyCharm
261 4
|
5月前
|
JSON 数据格式 Python
Flask实现内部接口----pycharm安装及新建,location代表着文件路径,下面是Python的环境,Flask是由Python开发的框架,Python文件接口ython通过GET发送
Flask实现内部接口----pycharm安装及新建,location代表着文件路径,下面是Python的环境,Flask是由Python开发的框架,Python文件接口ython通过GET发送
|
5月前
|
iOS开发 MacOS Python
【Python】已解决:(Pycharm切换Python版本后报错)No Python at “C:\Program Files\Python39\python.exe”
【Python】已解决:(Pycharm切换Python版本后报错)No Python at “C:\Program Files\Python39\python.exe”
367 0
【Python】已解决:(Pycharm切换Python版本后报错)No Python at “C:\Program Files\Python39\python.exe”
|
5月前
|
IDE 开发工具 Python
【Python】已解决:pip安装第三方模块(库)与PyCharm中不同步的问题(PyCharm添加本地python解释器)
【Python】已解决:pip安装第三方模块(库)与PyCharm中不同步的问题(PyCharm添加本地python解释器)
941 0
|
5月前
|
开发者 iOS开发 MacOS
【Python】已解决:Pycharm设置Python每个文件开头自定义模板(带上作者名、时间等)
【Python】已解决:Pycharm设置Python每个文件开头自定义模板(带上作者名、时间等)
191 0
|
5月前
|
语音技术 开发者 Python
语音识别,python运行H ~W~,要使用英符,执行Python的流程是输入Python,回车,解释器的两大功能,翻译代码,提交计算机运算,多行代码运行,写一个py文件,pycharm安
语音识别,python运行H ~W~,要使用英符,执行Python的流程是输入Python,回车,解释器的两大功能,翻译代码,提交计算机运算,多行代码运行,写一个py文件,pycharm安
|
Java Android开发 开发者
没有pycharm?JAVA开发者看好了,教你如何使用eclipse搭建python开发环境
前言有很多的IDE,今天为大家介绍一个eclipse+Pydev的组合,记录自己的配置。**一、前提准备** eclipse下载:http://www.eclipse.org/downloads/ PyDev下载:http://www.pydev.org/download.html Python下载:https://www.python.org/downloads/ jdk下载 :http://www.oracle.com/technetwork/java/javase/downloads/index.html 二、配置 废话不多说,说重点 安装JDK。
2564 0