今回は、Pythonのdocstring（ドックストリング）についてまとめてみました。 docstringは、Pythonコードの可読性を向上させるための非常に便利なツールです。特に、Pythonを学んでいる方や、コードの品質を向上させたい方にお役に立てればと思い執筆しました。

def example(): """これがdocstring（ドキュメント文字列）です""" # これは普通のコメント pass def calculate_total(items, tax_rate=0.1): """ 商品の合計金額を計算する 税込みの合計金額を計算して返す。 割引がある場合は割引後の金額で計算する。 Args: items (list): 商品の ...

This extension is designed to highlight docstrings in Python code, making it easier to read and understand the source code. It does not provide any support for editing or creating docstrings. It is ...

Docstrings for methods will contain a list of parameters and their type hints, list of raised exceptions and whether the method yields or raises. Class docstring will have a list of atributes. It uses ...