【Python】 Python ~ 基本編 / コメント文 ~

 ■ コメント文

1. 一行コメント文(# コメント)
2. 複数行コメント文(""" コメント """)

Pythonjavadoc 的なのは?

Docstring(ドック ストリング)ってのがある

Docstringのスタイル

Docstringのスタイルってのがあって、書式が違う。

【1】Googleスタイル
【2】NumPyスタイル
【3】reStructuredText (reST) スタイル

【1】Googleスタイル
https://qiita.com/11ohina017/items/118b3b42b612e527dc1d
https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
【2】NumPyスタイル
https://qiita.com/simonritchie/items/49e0813508cad4876b5a
【3】reStructuredText (reST) スタイル
https://sphinx-users.jp/articles/expertpython/restructuredtext.html

VS Code のDocstringに関する拡張機能

以下の関連記事を参照のこと。

https://dk521123.hatenablog.com/entry/2019/10/20/230323

■ ドキュメント化ツール

Doxygen(ドキシジェン) 

以下の関連記事を参照

https://dk521123.hatenablog.com/entry/38018326
Sphinx

以下のサイトを参照

https://qiita.com/futakuchi0117/items/4d3997c1ca1323259844
参考文献
https://qiita.com/tomopiro/items/407e3bf5c08342cd4867

関連記事

Python ~ 基本編 / 文字列 ~
https://dk521123.hatenablog.com/entry/2019/10/12/075251
Visual Studio Code
https://dk521123.hatenablog.com/entry/2019/10/20/230323