はてなブックマーク

初めに pythonのプロジェクトにおいて、個人的にフォルダ構造を考察してまとめる。 ただし、プロジェクトの目的に応じた構造や、時期（バージョン）に応じた構造、 推奨するソース（社会的権威）の差などがあるため、完全に標準的な構造はない。 そのため、記事として本構造が適切であると推奨しているわけではない。 プロジェクトの構造について まず、ソースコード、ドキュメント、テストを保管するフォルダ構造が基本構造となる。 そのため、pythonにおける一般的な名称を含めて以下は必須となる。 myproject：開発するプロジェクトの名称。名称は任意。 docs：ドキュメントの保管フォルダ。名称は固定（推奨）。 tests：テストコードの保管フォルダ。名称は固定（推奨）。

Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article?

初めに 実用として使用しているエディタ(VSCode)での拡張機能によるdcstring生成補助をさらりと紹介する。 自身の関連記事 ・docstringのスタイルと書き方。（2021/01/30） [Python] docstringのスタイルと書き方 ・VSCodeでのdocstring生成に関する機能拡張。（2021/02/01）←本記事 [Python] VSCodeでのdocstring生成拡張 ・docstringを利用した関数テスト。（2021/02/07） [Python] 関数のテストとその手法概要（dcstest, unittest, pytest） VSCode 大人気のエディタ。説明を引用します。 Visual Studio CodeはMicrosoftが開発しているWindows、Linux、macOS用のソースコードエディタである。 デバッグ、埋め込みGitコン

はじめに 非プログラミングエンジニアがPythonでdocstringを適切に運用するために情報をまとめた。 本内容では日本語記載を行うが、通常は推奨されない。 自身の関連記事 ・docstringのスタイルと書き方。（2021/01/30）←本記事 [Python] docstringのスタイルと書き方 ・VSCodeでのdocstring生成に関する機能拡張。（2021/02/01） [Python] VSCodeでのdocstring生成拡張 ・docstringを利用した関数テスト。（2021/02/07） [Python] 関数のテストとその手法概要（dcstest, unittest, pytest） docstringとは コード内で文字を記載する際の方法の一つ。 (#)をいれることでそれ以降がコメントとなる。コメントはコード内で無視される。 (""")で囲うことでdocst