■ はじめ
コメント文について扱う
目次
【１】Python の コメント文 【２】Python の javadoc 的なのは？ 【３】ドキュメント化ツール
【１】Python の コメント文
１）一行コメント文（# コメント） ２）複数行コメント文（""" コメント """）
【２】Python の javadoc 的なのは？
Docstring（ドック ストリング）ってのがある
Docstringのスタイル
Docstringのスタイルってのがあって、書式が違う。 １）Googleスタイル ２）NumPyスタイル ３）reStructuredText (reST) スタイル
１）Googleスタイル
https://qiita.com/11ohina017/items/118b3b42b612e527dc1d
https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
２）NumPyスタイル
https://qiita.com/simonritchie/items/49e0813508cad4876b5a
３）reStructuredText (reST) スタイル
https://sphinx-users.jp/articles/expertpython/restructuredtext.html
VS Code のDocstringに関する拡張機能
以下の関連記事を参照のこと。
Visual Studio Code ～ autoDocstring ～
https://dk521123.hatenablog.com/entry/2022/02/19/000000
【３】ドキュメント化ツール
* 以下の関連記事を参照のこと
Python ～ ドキュメント化ツール ～
https://dk521123.hatenablog.com/entry/2023/11/04/231802
関連記事
Python ～ 基本編 / 文字列 ～
https://dk521123.hatenablog.com/entry/2019/10/12/075251
Python ～ ドキュメント化ツール ～
https://dk521123.hatenablog.com/entry/2023/11/04/231802
Visual Studio Code ～ 入門編 ～
https://dk521123.hatenablog.com/entry/2019/10/20/230323
Visual Studio Code ～ Python拡張 ～
https://dk521123.hatenablog.com/entry/2020/10/10/000000
Visual Studio Code ～ autoDocstring ～
https://dk521123.hatenablog.com/entry/2022/02/19/000000
