目次
- AskYourCodeの概要
- AskYourCodeの機能
- AskYourCodeの利用シーン
- AskYourCodeの使用例
- AskYourCodeのコマンド・パラメーター
AskYourCodeの概要
AskYourCodeプラグインは、特定のプロジェクト、ディレクトリ、ファイル、またはコード構造（クラス、メソッド、関数、変数）についての情報を提供します。
AskYourCodeの機能
- 新しいプロジェクトの作成
- プロジェクト、ディレクトリ、ファイル、コード構造の要約
- ドキュメンテーションやコード構造の検索
AskYourCodeの利用シーン
- 新しいソフトウェアプロジェクトを理解する際
- 特定のコード構造やドキュメンテーションを検索する際
- プロジェクトの全体的な概要を把握する際
AskYourCodeの使用例
- ユーザー: 「プロジェクトの概要を教えてください」
- プラグイン: 「このプロジェクトは、XとYの機能を提供するソフトウェアです。主なコード構造にはA、B、Cがあります。」
- ユーザー: 「""calculate""という名前の関数を探してください」
- プラグイン: 「""calculate""という名前の関数は、""utils/math.py""にあります。この関数は、2つの数値を引数として受け取り、それらの合計を返します。」
AskYourCodeのコマンド・パラメーター
- コマンド: create
- url: プロジェクトの内容をダウンロードするためのGitHubリポジトリまたはzip/tar.gzアーカイブへのリンク
- コマンド: summarize
- project: プロジェクト識別子
- path: 特定のフォルダまたはファイルへのパス
- tail: ファイルパスの末尾
- name: コード構造の単純または完全修飾名
- コマンド: search
- project: プロジェクト識別子
- path: ファイルまたはフォルダパスの先頭を一致させる
- tail: ファイルパスの末尾を一致させる、例えば"".extension""または""filename.extension""
- name: コード構造の完全修飾名または単純名
- text: フリーテキスト検索表現
- limit: 返す検索結果の最大数
