zoukankan      html  css  js  c++  java
  • python学习--文档

      Python 文档资源

    形式 角色

    #注释

    文件中的文档

    dir函数

    对象中可用属性的列表

    文档字符串:__doc__

    附加在对象上的文件中的文档

    PyDoc:help函数

    对象的交互帮助

    PyDoc:HTML报表

    浏览器中的模块文档

    标准手册

    正式的语言和库的说明

    网站资源

    在线教程、例子等

    出版的书籍

    商业参考书籍

    一、dir函数

    要找出内置对象类型提供了哪些属性,可运行dir并传入所需要类型的常量

    比如说我想查看内置turtle标准库查看哪些方法,可以如下操作:

    dir 函数可作为记忆提醒器,提供属性名称的列表,但并没有告诉哪些名称的意义是什么?比如说我想看一下关于turtle这个库的介绍说明或 ‘fd’方法该怎么办呢?

    二、文档字符串:__doc__

    除了#注释外,Python也支持可自动附加在对象上的文档,而且在运行时还可保存查看。从语法上来说,这类注释是写成字符串,放在模块文件、函数以及类语句的顶端,就在任何可执行程序代码前(#注释在其前也没有问题)。Python会自动封装这个字符串,也就是成为所谓的文档字符串,使其成为相应对象的__doc__属性。

    现在回答上面的问题:

    print(turtle.__doc__) 或 print(turtle.fd.__doc__)即可查看

     

     对应源码内容

    PyDoc: help 函数

      文档字符串技术已被证明是实用的工具,Python现在配备了一个工具,使其更易于显示。标准PyDoc工具是Python程序代码,知道如何提取文档字符串并且自动提取其结构化的信息,并将其格式化成各种类型的排列友好的报表。

     比如说想查看turtle的帮助文档,可以用help(turtle) ;如果想查看turtle的fd方法帮助文档,可以用help(turtle.fd)

    三、PyDoc: HTML报表

      PyDoc 也提供GUI接口,可以将其报表通过HTML网页格式来呈现,可通过任何网页浏览器来查看。

      启动方式:

     

    命令行启动:

    四、帮助标准手册

  • 相关阅读:
    web设计师和前端设计师的互动—前端工程师应该具备的三种思维
    PyQt入门系列(一):Hello World
    PIL在windwos系统下Image.show无法显示图片问题的解决方法
    大赛学习笔记
    ArcGIS Add-in开发(一)--获取选定要素的属性值
    【转】WPF颜色相关操作
    斗地主小代码
    MAVEN配置私服仓库
    Error creating bean with name 'transactionManager' defined in ServletContext resource XXX
    org.hibernate.HibernateException: getFlushMode is not valid without active transaction
  • 原文地址:https://www.cnblogs.com/hayden1106/p/7838056.html
Copyright © 2011-2022 走看看