#pycharity 「DocString 3つの書き方の紹介。NumPy Style と Google Style は型ヒント導入前のスタイル。型ヒントと組み合わせるなら reST Style がおすすめ」
2020-07-04 14:41:58VSCodeのPythonDocstringGeneratorを使うとよりdocstringが書きやすい #pycharity
2020-07-04 14:42:25Numpy Style, Google StyleだとTypeHintsに対応していない。TypeHintsを使うならReST Styleがオススメ #pycharity
2020-07-04 14:42:31今から選ぶならRestructuredTextがおすすめ。publicなメソッドで始めてみよう #pycharity
2020-07-04 14:42:55(ReSt, TypeHintsは仮引数リストに) :param arg1: desc1 :param arg2: desc2 :return: desc #pycharity
2020-07-04 14:43:17#pycharity reSTスタイル + 型ヒント パブリックなメソッドからだけでも→始めやすそう! VSCodeはautoDocstringがある?
2020-07-04 14:43:18Visual Studio CodeにもReStructuredTextの拡張ありますね。marketplace.visualstudio.com/items?itemName… #pycharity
2020-07-04 14:44:22#pycharity DosctringのPEP python.org/dev/peps/pep-0… ワンラインのときはシグネチャはオススメしない、概要を書くなどPEPにもノウハウありますね
2020-07-04 14:45:07#pycharity くーむ「私最初(ReadTheDocsの)青いのがテンプレだと分からなくて、この青いスタイルの人めっちゃいろんなドキュメントかいてるな・・・!って思ってました」www
2020-07-04 14:45:11docstringの運用、仕様書とかER図を継続的に書いてもらうのに近い苦労がある。 #pycharity
2020-07-04 14:46:49ただ、docstringは仕様書とかER図ほど体力が必要ないので、CIとかである程度強制してあげて、書かなきゃいけない状態を作るのは割と良い解決策っぽい。 #pycharity
2020-07-04 14:47:56