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

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

A tool that automatically generates docstrings for Python code using LLM APIs. It processes Python files recursively and creates files with inserted docstrings while preserving the original codes.

Once all existing docstrings are formatted according to Google Codestyle, a configuration should be added for regular formatting of new code. ruff config example for ...