0
点赞
收藏
分享

微信扫一扫

深度学习 --- stanford cs231学习笔记八(训练神经网络之dropout)

三维控件研究 2024-07-24 阅读 31

背景

最近在开发过程中,突然发现还有一个东西叫做文档字符串的玩意,原来函数的注释还能这么用??python再次刷新了我的认知。以前函数注释我都是写在函数之前,现在看来,是我的代码不够规范了。正确的方式应该如下所示,这样直接通过func._doc_就可以获取该函数的说明,可谓是方便至极

Python 文档字符串(DocStrings)

DocStrings 文档字符串是一个重要工具,用于解释文档程序,帮助你的程序文档更加简单易懂。

我们可以在函数体的第一行使用一对三个单引号 ''' 或者一对三个双引号 """ 来定义文档字符串。

你可以使用 __doc__(注意双下划线)调用函数中的文档字符串属性。

#!/usr/bin/python
# -*- coding: UTF-8 -*-
 
def function():
    ''' 
    say something here!
    '''
    pass
 
print (function.__doc__) # 调用 doc

输出结果为: say something here!

DocStrings 文档字符串使用惯例:首行简述函数功能,第二行空行,第三行为函数的具体描述

#!/usr/bin/python
# -*- coding: UTF-8 -*-
 
def printMax(x,y):
    '''
    打印两个数中的最大值。
    
    两个值必须都是整形数。
    '''
    x=int(x)
    y=int(y)
    if x>y:
        print(x,'最大')
    else:
        print(y,'最大')
        
printMax(3,5)
print (printMax.__doc__) # 调用 doc

输出为:
    打印两个数中的最大值。

    两个值必须都是整形数。
 

举报

相关推荐

0 条评论