Python学习笔记之三：两种注释

最新推荐文章于 2024-06-04 09:00:00 发布

b10l07

最新推荐文章于 2024-06-04 09:00:00 发布

阅读量83

点赞数

CC 4.0 BY-SA版权

文章标签： python

原文链接：http://www.cnblogs.com/zanzan101/p/3647203.html

本文介绍了Python中两种注释方式，并重点讲解了文档字符串的使用方法及其与常规注释的区别。通过示例展示了如何利用help函数及__doc__属性访问文档字符串。

Python中有两种注释方式，一种是前置#符号，另一种是直接使用字符串""或"""。

后者称为文档字符串，除了带有常规注释的描述功能外，还可以通过help及生成文档的方法访问到，而常规注释无法访问。

下面使用help和__doc__两种方法访问文档字符串，示例代码如下：

>>> def foo(x):
    #this is a function for fun
    return x*3

>>> foo("Hello ! ")
'Hello ! Hello ! Hello ! '
>>> def foo(x):
    "this is a function for fun"
    return x*3

>>> foo("Hi ! ")
'Hi ! Hi ! Hi ! '
>>> help(foo)
Help on function foo in module __main__:

foo(x)
    this is a function for fun

>>> foo.__doc__
'this is a function for fun'
>>>