2015-01-05 3 views
9

関数が何も返さないときのdocstringの規則は何ですか?例えば何も返されないときは、ドキュメントストリング

def f(x): 
    """Prints the element given as input 

    Args: 
     x: any element 
    Returns: 
    """ 
    print "your input is %s" % x 
    return 

私はドキュメンテーション文字列にReturns:後に何を追加する必要がありますか?今は何もない? Pythonで

"""Prints the element given as input 

Args: 
    x: any element 
Returns: 
    None 
""" 

すべての機能が何かを返す:それはあなたの関数が実際に返すものですよう

答えて

12

あなたは、Noneを使用する必要があります。あなたが明示的に値を返さない場合、それらはデフォルトでNoneを返します。

>>> def func(): 
...  return 
... 
>>> print func() 
None 
>>> 
+0

はフォローアップ:それはそれを省略することが間違っていますか? (暗黙のなし) – keyser

+0

私は正確に理解できません。 'return None'の代わりに' return'をするだけでいいのであればいいですか?はい、それは問題ありません。その場合の 'None'の追加は冗長です。値を返さない場合、Python関数は 'None'を返します。 – iCodez

+0

いいえ、文章の戻り部分を省略します。 – keyser

関連する問題