torinaブログ

DjangoとBootstrap4で作成したブログ
Python, Django, Kivy, Bootstrap, Apache等のメモです
ソースコード

Python、ドキュメンテーション文字列(docstring)

Python Pythonスタイルガイド
約483日前 2015年11月1日18:33
https://www.python.org/dev/peps/pep-0257/
http://diveintopython3-ja.rdy.jp/your-first-python-program.html

を参考にこんな感じで書いてみようとおもった
def spam(src,alt=`がぞうです`):
    '''
    imgタグを生成する

    キーワード引数:
    src -- 画像のURL
    alt -- 画像の説明文 (default `がぞうです`)
    '''

    tag = `<img src={} alt={}/>`.format(src, alt)
    return tag

>>> help(spam)
Help on function spam in module __main__:

spam(src, alt='がぞうです')
    imgタグを返します
    
    キーワード引数:
    src -- 画像のURL
    alt -- 画像の説明文 (default `がぞうです`)


いずれ修正予定