💻

Gemini Code Assist応用例 Python + SQLite：⑤ドキュメントと仕上げ

に公開
AI
Python
SQL
CRUD
gca
tech

💻 GCA応用例：⑤ドキュメントと仕上げ

Docstringの追加とREADME.mdの作成の2段階に分けて修正します。

1. Docstringと型ヒントの追加依頼（コード本体の仕上げ）

  • 指示: todo.pyのロジックに、Docstringと型ヒントを追加します。この作業により、コードの仕様が明確になります。

    【プロンプト】

    @todo.py のすべての関数に、Docstringと適切な型ヒントを追加し、Pythonのベストプラクティスに従ってリファクタリングしてください。余分なコメントは削除してください。

  • 提案の確認と適用: GCAが、各関数の仕様を明確にしたDocstringと型ヒントをコードに反映させる提案を提示します。内容を確認し、「Accept」をクリックしてファイルを更新します。

2. README.mdの作成依頼（詳細ドキュメントの分離）

  • 指示: 読者や他の開発者向けに、アプリの使用方法とファイル構成を説明するREADME.mdファイルを生成させます。

    【プロンプト】

    @workspace の todo.py と database.py の内容を基に、アプリの実行方法とファイル構成を説明する README.md ファイルを作成してください。

  • 提案の確認と適用: GCAが、アプリの概要とセットアップ手順が記載されたREADME.mdを提案します。「Accept」をクリックしてファイルを生成します。

関連記事
Gemini Code Assist応用例 Python + SQLite：①ファイル構成の作成
Gemini Code Assist応用例 Python + SQLite：②データベース作成
Gemini Code Assist応用例 Python + SQLite：③メインロジックの実装
Gemini Code Assist応用例 Python + SQLite：④単体テスト
Gemini Code Assist応用例 Python + SQLite：⑤ドキュメントと仕上げ
Gemini Code Assist応用例 Python + SQLite：⑥実行と最終動作確認
Gemini Code Assist応用例 Python + SQLite：⑦注意事項

Discussion