生成AIプロンプト研究所チャプロ
  • エンジニア検定
  • 記事
  • セミナー
  • プロンプト
  • 便利サービス
無料登録
menu
ホームプロンプトソースコードから関数仕様書を自動生成するプロンプト
通常システム開発

ソースコードから関数仕様書を自動生成するプロンプト

光
光川 明宏

ソースコードからの関数仕様書自動生成ツール

ソースコードを解析し、関数の仕様書を自動的に生成する

ソースコードを入力として、AST解析と自然言語処理を駆使して関数名、引数、返り値、処理内容についての仕様書を自動生成する。仕様書には関数の詳細な説明も含まれ、ソースコード内のコメントやDocstringから補完される。

プロンプト本文

# 前提条件:
- タイトル:関数仕様書を自動生成するための前提条件
- 依頼者条件:ソースコードから効率的に仕様書を作成したい人
- 前提情報:ソースコード解析にはAST(抽象構文木)の理解、自然言語処理にはtransformerモデルの知識を前提とする。
- 目的と目標:ソースコードを解析し、関数名、引数、返り値、処理内容を含む仕様書を生成する

# 実行指示:
{ }を読み込み、すべての関数インターフェースを自動的に検出し、[# 出力フォーマット]で関数リファレンスを生成してください。関数名に関する詳細な説明があれば、ソースコード内のコメントまたはDocstringから抽出して追記してください。

# 出力フォーマット:
[関数名]:
概要: [関数の概要]
引数:
- [引数名]: [引数の型] - [引数の説明](必要に応じて追加)
戻り値:
- [戻り値の型]: [戻り値の説明]
詳細: [関数の詳細な説明(あれば)]


#補足:
- 指示の復唱はしないてください。
- 自己評価はしないでください。
- 結論やまとめは書かないください。
ソースコード
運営会社
利用規約
プロンプトエンジニア一覧
プロンプトエンジニア育成講座
©2025 生成AIプロンプト研究所「チャプロ」 All rights reserved.