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

[oeasy]python049_帮助手册_pydoc_manual_document

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

帮助手册回忆上次内容

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

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

多行的
三个"
三个'

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

增加描述说明 #!/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 查询优化
下一篇：四川云教电视课堂线上教学最全操作手册

相关推荐

重生之我在头条学html网页编程，这一世我一定学好，成为编程高手: 有人要问了html是什么东西?就是用来设计网页的一种语言会不会很难啊?这是很多朋友担心的，我告诉大家这是最简单最基础也最容易学习的一款入门级语言，当初我也是经常因为学不会C语言而苦恼自从学习了html...

如何在网页3D CAD中创建一个三维管道模型: 前言在网页CAD中进行三维建模是一项有趣的任务。本文将介绍如何利用mxcad3d来创建三维管道模型。该工具提供了一系列三维建模功能的API，使得建立复杂的管道结构变得简单直观。安装在此之前，需要先安装...

网页模版如何用: 网页模版已成为如今网站建设的核心工具。随着互联网需求的增长，越来越多的企业和组织需要建立自己的网站，以展示他们的品牌和服务。在这个过程中，网页模版为他们提供了一种简单而高效的方式来构建网站。所谓网页模...

AI嵌入式Flowcode编程网页开发人员入门指南: WebDeveloper允许使用FlowcodeIDE环境开发具有交互性的网页。可以在2D面板中添加特殊网页组件，以创建网页的视觉表示，并可以使用流程图添加交互功能。它的引入意味着Flowcod...

用Deepseek制作网页版的汉诺塔游戏保姆级教程: 在deepseek中输入：“帮我做一个网页版的汉诺塔演示游戏，游戏包含2层、3层、4层、5层的汉诺塔游戏演示，制作自动求解演示按钮，点击按钮就可以生成出步数，同时自动演示最优解动画。”最后把生成的程序...

TaskBuilder前端页面CSS样式规则设置: 在前端页面设计器内，点击底部的“CSS样式”选项卡，可以打开CSS样式设计器，在此查看和设计当前页面的CSS样式规则，如下图所示：3.3.6.1引入外部样式文件如果要在页面中引入外部CSS文件，可以点...

使用 Python、FastHTML 和 Uvicorn 构建简单的博客网站: FastHTML是2024年7月推出的PythonWeb框架，是一个简单但功能强大的框架，允许开发人员使用纯Python构建Web应用程序。（不需要复杂的模板引擎）。Fast...

用AI可以生成HTML网页了，很多初级前端都要失业了: 即使你完全不懂html，javascript,css，也能做出漂亮的网页，这在以前是不可想象的，而现在确是可行的，因为有这样一个项目：openUI。openUI不仅仅能生成html页面，还能生成自适应...

python原始套接字socket下载http网页文件到txt: python原始套接字socket下载http网页文件到txtimportsocketdefdownload_webpage(url,output_file):try:...

高效排版:实现DeepSeek生成内容Word格式排版并导...: 高效排版：实现DeepSeek生成内容Word格式排版并导出的经典方法，步骤简洁高效：DeepSeek生成内容复制出来容易出现乱码，下面介绍一种比较高效简单的方法！一、核心三步法1.调整模型模式在D...

打工人福音!3分钟教你学会word精美排版: 昨天大熊介绍了word一键排版的三种办法，今天我们来详细讲讲第二种办法，用html代码实现一键排版，然后再导出pdf实现精美效果。打工人，打工魂，你是不是也有以下烦恼？下面是我经过多次和Deepsee...

使用 HTML 创建可折叠的交互式组件，一行 JS 代...: 如果你想创建一个可折叠的交互式组件，使用<details>元素即可，一行JavaScript也不用写。<details>组件定义了一个可折叠的容器，它的第一个元素必须...

新手小白1分钟学会Word——文档的编辑1.1: 天空一声巨响，迷人的我闪亮登场，亲爱的家人们，周末好呀！话不多说，咱们继续开干！昨天说到本节还有个小尾巴，那咱们就把这个小尾巴了结了，然后开始新篇章~四、保存文档我们对文档编辑完之后最重要的一步就...

超强!DeepSeek+HTML制作数据看板，老板看了都点赞: DeepSeek以极强的推理能力，支持生成各种代码，比如Python、SQL、Matlab、JS、HTML等，你可以拿这些代码放到编译器里，就能直接跑出结果，比如机器学习算法、exe应用、可视化图表、...

什么是Tailwind CSS: 什么是TailwindCSSTailwindCSS是一个实用优先(Utility-First)的CSS框架，其核心思想是通过直接在HTML中组合预定义的类名来快速构建界面样式，无需编写传...

一周热门

最近发表

首页
收录
顶部