Module `test4pdoc`

モジュール test4pdoc は，pdoc の動作を確認するためのものです．

この小さなモジュールは，pdoc によるドキュメントの自動生成を試すために作られたものです．そのため，その役以外にはたちそうにないような内容しか含まれていません．

pdoc が対応している docstring のマークアップ方式としては， reST や Google 様式のものなどがありますが，ここでは Markdown を利用しています．

Expand source code

#!/usr/bin/env python3
# -*- coding: utf-8 -*-


"""
モジュール `test4pdoc` は，pdoc の動作を確認するためのものです．

この小さなモジュールは，[pdoc](https://pdoc3.github.io/pdoc "pdoc") による
ドキュメントの自動生成を試すために作られたものです．
そのため，その役以外にはたちそうにないような内容しか含まれていません．

pdoc が対応している docstring のマークアップ方式としては，
reST や Google 様式のものなどがありますが，
ここでは Markdown を利用しています．
"""


def greet(name="名無しさん"):
    """誰かに簡単な挨拶をします．

    挨拶をする相手の名前を `name` として指定すると，
    その対象への挨拶を文字列として出力します．

　  """
    
    return "こんにちは，{} さん．".format(name)



def main():
    """`greet` の動作を確認するための関数です．

    実行すると，プロンプトともに，あなたの名前を標準入力から取得します．
    これが成功すると，あなたへの挨拶を標準出力に書き出します．
    """

    name = input("あなたの名前を教えてください: ")
    print(greet(name))


if __name__ == "__main__":
    main()

Functions

def greet(name='名無しさん')

誰かに簡単な挨拶をします．

挨拶をする相手の名前を name として指定すると，その対象への挨拶を文字列として出力します．

Expand source code

def greet(name="名無しさん"):
    """誰かに簡単な挨拶をします．

    挨拶をする相手の名前を `name` として指定すると，
    その対象への挨拶を文字列として出力します．

　  """
    
    return "こんにちは，{} さん．".format(name)

def main()

greet() の動作を確認するための関数です．

実行すると，プロンプトともに，あなたの名前を標準入力から取得します．これが成功すると，あなたへの挨拶を標準出力に書き出します．

Expand source code

def main():
    """`greet` の動作を確認するための関数です．

    実行すると，プロンプトともに，あなたの名前を標準入力から取得します．
    これが成功すると，あなたへの挨拶を標準出力に書き出します．
    """

    name = input("あなたの名前を教えてください: ")
    print(greet(name))