日々精進

新しく学んだことを書き留めていきます

PyCharmでdocstringのひな形を生成する

関数定義のすぐ下で"""を入力し、Enterをおすとひな形が生成される。 例は以下。

    def __init__(self, border: BoxPoint, name: BoxPoint, original_image: np.ndarray):
        """
        Args:
            border: 
            name: 
            original_image: 
        """
   

このひな形の形式はSettings>Tools>Python Integrated Tools>Docstrings>Docstring formatで選択できる。 GoogleStyleが一番シンプルで良さそうだったのでこれを使うことにした。各スタイルについては以下参照。

note.nkmk.me

pleiades.io