当前位置 > it书童 > 知识体系 > 正文
推荐小册
java高效编程
怎样更高效地用 java 编程

juc并发工具库
java并发编程工具库

设计模式
设计模式

jvm调优
jvm调优

rabbitmq实战
rabbitmq实战

redis实战
redis实战

Keepavlied高可用集群
Keepavlied高可用集群

nginx入门到实战
nginx入门到实战

java调试
java调试中遇到的各种坑

java输入输出流
java输入输出流

使用 pydoc 生成文档

知识体系 it书童 2019-10-03 22:06:35 0赞 0踩 1067阅读 0评论

fkmodule.py

MY_NAME = '疯狂软件教育中心'


def say_hi(name):
    """
    定义一个打招呼的函数
    返回对指定用户打招呼的字符串
    :param name: 名称
    :return:
    """
    print('执行 say_hi 函数')
    return name + "您好!"


def print_rect(height, width):
    """
    定义一个打印矩形的函数
    :param height: 代表矩形的高
    :param width: 代表矩形的宽
    :return:
    """
    print('*' * width + '\n')


class User:
    NATIONAL = 'China'
    """
    定义一个代表用户的类
    该类包括 name age 两个变量
    """
    def __init__(self, name, age):
        """
        初始化用户数据
        :param name: 用户名称
        :param age: 用户年龄
        """
        self.name = name
        self.age = age

    def eat(self, food):
        """
        定义用户吃东西
        :param food: 食物
        :return:
        """
        print('%s正在吃%s' % (self.name, food))

在控制台中查看文档

$ python -m pydoc fkmodule

并不方便

生成 html 文档

$ python -m pydoc -w fkmodule
wrote fkmodule.html

启动本地服务器进行动态查看

关于我
一个文科出身的程序员,追求做个有趣的人,传播有价值的知识,微信公众号主要分享读书思考心得,不会有代码类文章,非程序员的同学请放心订阅
转载须注明出处:https://www.itshutong.com/articles/22/using-pydoc-to-generate-documents