当前位置：网站首页 > 文章教程 > 正文

[oeasy]python049_帮助手册_pydoc_manual_document

yund56 2025-04-23 17:39 29 浏览

帮助手册回忆上次内容

上次了解了注释
注释是为了让程序更可读
注释不会影响程序运行速度

注释分为两种
单行的
以#开头
不能是字符串当中的#

多行的
三个"
三个'

多行注释还有什么特殊功能么？

增加描述说明 #!/usr/bin/python3 #vim: set fileencoding=utf-8 ''' 关于当前模块的说明 '''

完整的main.py如下所示
:r !whoami
可以得到当前用户名

:r !date
可以得到当前日期时间

:w
写完之后保存

添加图片注释，不超过 140 字（可选）

注意已经设置了编码格式
可以在命令行中
查看到 main.py 的帮助手册吗？

刷新帮助手册

观察帮助手册
python3 -m pydoc main

添加图片注释，不超过 140 字（可选）

这很眼熟啊
可以到游乐场里面
首先 import main
然后 help(main)

生成帮助手册

一样可以看到相关的文档

添加图片注释，不超过 140 字（可选）

在当前路径，进入游乐场之后
import main
help(main)

可以生成帮助网页吗？
就像官方的那种帮助一样

官方的帮助什么样子？

python3 在线

python3 本身有在线的文档
在http://docs.python.org

添加图片注释，不超过 140 字（可选）

可以生成我代码的文档吗？

生成网页

python3 -m pydoc -w main
对于 main.py 生成帮助网页
帮助文件叫做 main.html

添加图片注释，不超过 140 字（可选）

帮助文件就生成在当前的 test 文件夹

打开帮助网页

然后用火狐打开这个网页文件
firefox main.html

添加图片注释，不超过 140 字（可选）

右上角是两个链接
当前文件夹索引
当前 html 对应的 py 文件

下面是 main 里面的内容
相关的三引号描述

再下面是三个链接
是 main.py 引入的三个 module
目前这三个模块的链接都无法打开
因为没有生成

更新其他模块帮助文件

修改三个 py 文件的内容
其中 get_fruits 本来就有三引号注释
python3 -m pydoc -w get_fruits

添加图片注释，不超过 140 字（可选）

添加图片注释，不超过 140 字（可选）

只有顶端的三引号注释才被写入模块帮助
下面的三引号注释被忽略

修改模块注释

修改 get_fruits.py
保存并写帮助网页
python3 -m pydoc -w get_fruits

添加图片注释，不超过 140 字（可选）

任务完成
把文档写在代码里好吗？

代码即文档

CodeAsDocumentation

添加图片注释，不超过 140 字（可选）

让源代码更容易阅读和理解
尽量减少维护或扩展遗留系统所需的工作量
减少系统的用户和开发人员查阅二级文档来源的需要
通过自成一体的知识表征促进自动化

这很敏捷

添加图片注释，不超过 140 字（可选）

总结

这次了解了帮助文档的生成
开头的三引号注释可以生成帮助文档
文档可以写成网页

python3 本身
也有在线的帮助手册

目前的程序
提高了可读性

添加图片注释，不超过 140 字（可选）

有什么方法
可以让程序更可读么？

下次再说！
蓝桥->https://www.lanqiao.cn/courses/3584
github->https://github.com/overmind1980/oeasy-python-tutorial
gitee->https://gitee.com/overmind1980/oeasypython

css查询手册

上一篇：MySQL 8.0参考手册 - Limit 查询优化
下一篇：四川云教电视课堂线上教学最全操作手册

相关推荐

如何在Office 中编辑 PDF?附详细化步骤: PDF很受欢迎，因为它能在不同的设备和操作系统上仍然保持原有格式。但是，这也意味着直接更改PDF文件比其他格式更难更复杂。值得庆幸的是，Microsoftoffice和UPDF帮你解决这一难题。一...

我的 Windows 装机必备软件清单: 今天给大家分享下我的装机必备软件，都是用了好多年的软件神器。靠谱、好用、无广告，Windows电脑必备软件，收藏这一篇就够了！01.浏览器王者：Chromehttps://www.google.c...

Docnet Core 是一个轻量级、高性能的 .NET PDF 操作库: DocnetCore介绍DocnetCore是一个轻量级、高性能的.NETPDF操作库，依托于PDFium渲染引擎，提供强大的PDF文档解析、渲染、操作等功能。它完全支持.NET...

分享三款好用的PDF编辑软件，轻松处理PDF: 作为一名需要经常和PDF文件打交道的工作者，我来分享一下几款好用的PDF编辑软件，并详细分析了它们的优缺点，希望能帮你找到合适的工具。1.AdobeAcrobatDC作为PDF格式的发明者，Ado...

PDF文档创建工具软件:novaPDF OEM 11.9 Build 432 for Windows: novaPDFOEM是一款实用高效的软件，从头开始设计，让您尽可能轻松地在应用程序中添加PDF打印功能。换句话说，这个实用程序是专门为应用程序开发人员设计的，可以直接在程序安装程序中集成为PDF打印...

线性表顺序存储结构求集合的并，交，补，差(源代码附上超详细): 一：算法分析1）用数组A，B，C，E表示集合。假定A={1,3，4，5，6，7，9，10},　　B={2，,3，4，7，8，10},E={1,2，3，4，5，6，7，8，9，10},　　输入数组A...

分享一套SpringBoot开发博客系统源码，包含完整开发文档和视频: 基本信息项目名称：eblog摘要：eblog是一个基于Springboot2.1.2开发的博客学习项目，为了让项目融合更多的知识点，达到学习目的，编写了详细的从0到1开发文档。主要学习包括：自定义Fr...

通达信指标合集〔源码齐全〕: 很多朋友问到我哪款指标好用，这里我说一下，之所以有很多不同的指标是因为我们在针对不同的盘面情况的时候使用的指标是不同的，我给到的指标一般来讲就目前的环境来讲都是比较适合的，今天我就把我平时自己常用的指...

巅峰对决!Spring Boot VS .NET 6: SpringBoot和ASP.NETCore都是企业中流行的Web框架,对于喜欢C#的人会使用ASP.NETCore,而对于Java或Kotlin等基于JVM的语...

在asp.net core 中控制访问权限的方法: Intro#由于项目需要，需要在基于asp.netmvc的Web项目框架中做权限的控制，于是才有了这个权限控制组件，最初只是支持netframework，后来dotnetcore2.0...

ASP.NET是否无生存之地?: ASP.NET，这个已经很久的技术，总觉得已经被时代淘汰，我们公司是一个10人小公司，几个十年十五年的项目还是用ASP.NET开发的。这两年由于客户的需求变化，我们公司也顺势开始对这些项目重新开发，改...

Spring Boot + Vue.js 实现前后端分离(附源码): 作者：梁小生0101链接：juejin.im/post/5c622fb5e51d457f9f2c2381SpringBoot+Vue.js前后端涉及基本概念介绍，搭建记录，本文会列举出用到环...

ASP.NET Core 中的 Mapster 使用入门教程: 在本文中，我们将学习如何在ASP.NETCore应用程序中使用Mapster。首先，我们将了解Mapster是什么以及如何将其安装到.NETCore应用程序中。然后，我们将在使用...

Asp.net常用方法及request和response-a: asp.net教程asp.net常用方法:1、Request.UrlReferrer请求的来源，可以根据这个判断从百度搜的哪个关键词、防下载盗链、防图片盗链，可以伪造(比如迅雷)。(使用全局一般处理...

ASP.NET Core使用功能开关控制路由访问: 前言在前面的文章，我们介绍了使用Middleware有条件地允许访问路由（《ASP.NETCore使用Middleware有条件地允许访问路由》）。而对于一些试验性的功能，我们并不希望用密码去控制是...

一周热门

最近发表

首页
收录
顶部