前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Python注释与doctoring

Python注释与doctoring

作者头像
TalkPython
发布2019-06-11 15:15:33
1.3K0
发布2019-06-11 15:15:33
举报
文章被收录于专栏:TalkPython
单行注释、多行注释
  • 单行注释
代码语言:javascript
复制
# 这是python的单行注释
  • 多行注释
代码语言:javascript
复制
这是多行注释
这是多行注释
以编程方式访问文档字符串

与常规注释不同,docstring是作为它们所记录的函数的属性存储的,这意味着您可以通过编写程程序访问它们。

代码语言:javascript
复制
def func():
    """这是一个函数的注释说明"""
    return 

这个注释字符串,可以通过函数属性doc来访问。

代码语言:javascript
复制
print(func.__doc__)

运行程序后,输出:

这是一个函数的注释说明

docstring相对于常规注释的优点

在函数中不添加docstring或常规注释就会大大降低它的帮助。例如:

代码语言:javascript
复制
def greet(name, greeting="Hello"): 
    # Print a greeting to the user `name` 
    # Optional parameter `greeting` can change what they're greeted with.
    print("{} {}".format(greeting, name))

print(greet.__doc__)

运行上面的代码,就会输出:

None

help(greet)

Help on function greet in module main: greet(name,greeting='Hello')

使用docstring编写注释文档

docstring是一个多行注释,用于记录模块、类、函数和方法。它必须是它所描述的组件的第一个语句。

代码语言:javascript
复制
def help(name):
"""
Greet someone.
Print a greeting("Hello") for the person with the given name.
"""

print("Hello " +name)

class Greeter:
    """
    An object used for greet people.
    It contains multiple greeting functons for servral languages and times of the day.
    """

print(hello.__doc__)
print(Greeter.__doc__)

运行后,分别输出:

Greet someone. Print a greeting("Hello") for the person with the given name.

An object used for greet people. It contains multiple greeting functons for servral >languages and times of the day.

如果觉得内容还不错,分享给更多朋友,一起提升编程技能。

本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2019-06-03,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 TalkPython 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 单行注释、多行注释
  • 以编程方式访问文档字符串
  • docstring相对于常规注释的优点
  • 使用docstring编写注释文档
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档