在使用python进行编程的时候,尽量遵循Google python编程规范,模块开头填写模块描述,每一个函数下面填写注释,然后使用python doc模块生成相关文档 使用

pydoc SocketClient  

会在命令窗口中得到程序的说明文档:

Help on module SocketClient:

NAME  
    SocketClient - Socket连接服务器,自带心跳包,调用initSocket并传入一个Queue对象,即可产生队列消息到queue中

FILE  
    /Users/qinfei/PycharmProjects/test/SocketClient.py

FUNCTIONS  
    QueueTest(q)
        线程worker函数
        用于处理队列中的元素项,这些守护线程在一个无限循环中,只有当主线程结束时才会结束循环

    closeSocket()
        关闭socket
        :return:

    connect_callback(q)
        连接成功之后运行的函数,此函数开启socket接受线程,和心跳包线程
        :param q: 队列对象用于传递到socket接受线程中去
        :return:

    heartBeat()
        心跳包数据,其中数据根据应用场景自行更改
        :return:

    initSocket(HOST, PORT, q)
        初始化socket连接
        :param HOST: str类型,socket服务器地址,可以为ip或者domain
        :param PORT: int类型,socket服务器地址
        :param q: 队列对象用于传递到socket接收线程中去,作为数据生产者
        :return:

    openSocket(ADDR, q)
        打开socket连接
        :param ADDR: 传入地址元组(HOST, ADDR)
        :param q: queue对象,用于传递到接受的线程
        :return: 没有返回值

    socketRecv(q)
        socket接受函数,放在一个独立线程中,接收到的数据写入到Queue队列中
        :param q: Queue 队列对象,传入之后socket接受线程会把数据写入到队列中,使用queue取出数据即可
        :return: 没有返回值

    socketSend(data)
        socket发送函数
        :param data: 传入需要发送的数据
        :return:

    uploadRealTimeData()
        上传实时数据

    uploaddata()
        仅作测试,不应该使用
        :return:

DATA  
    BUFFSIZE = 1024
    socketAlive = False
python -m pydoc -w SocketClient SocketClient.html  

会得到如下输出:

wrote SocketClient.html  
no Python documentation found for 'SocketClient.html'  

然后该目录中就会出现*.html文件,直接食用浏览器打开,效果如下: img

爽不爽?!