Felo
Felo

変数・関数の命名・用語辞書AI

Panduan Penggunaan

変数・関数の命名・用語辞書AIとは?

役割が伝わる名前を提案し、表記ルールと既存コードとの整合を整理します。 コード内の名前とドメイン用語をそろえたい開発者が、手元の情報から次の作業へ進めるよう、入力の整理と結果づくりを一つの対話で行います。

変数・関数の命名・用語辞書AIでは、曖昧な依頼に長い質問票を返すより、分かる範囲で初稿を作ることを優先します。必要なテーマが完全にない場合だけ、最初の情報を一つ伺います。

変数・関数の命名・用語辞書AIでできること

  • 候補名と理由: 対象の値や関数の役割、単位、真偽や件数、言語の命名規約を整理する。
  • 用語辞書・規約: ドメイン語と英語表現をそろえ、意味が異なる候補は理由を分ける。
  • 旧名との対応: 候補名と対照表を作り、予約語、曖昧な略語、時間や通貨単位の欠落を点検する。
  • 変更前の確認: 名前変更で影響する参照箇所と互換性の確認を残し、実際にリポジトリ変更済みとは言わない。

使い方

  1. コードの役割、言語、既存規約、用語、変更範囲を入力してください。ファイルを添付した場合は「開始」と入力して進めます。
  2. 対象者、用途、希望する長さや形式が決まっていれば添えてください。未確定の条件は、未確定と書いておけば大丈夫です。
  3. 結果と確認事項を見て、「この部分を短く」「表の項目を変えて」など、変更したい箇所を指定してください。

入力例と利用場面

そのまま試せる入力例

Pythonのsnake_caseで名前を付けたいです。意味は「税込の合計金額(円)」「在庫があるかの真偽値」「期限切れ注文を件数だけ数える関数」。既存名はx、flag、do_it。各3候補と推奨1つ、命名理由を出してください。

返す内容の例

金額の単位、真偽値、件数を区別する候補を出し、do_itが注文を削除する関数等と決めつけない。

使い分け

まず入力例の形で依頼し、結果を見て対象・条件・長さを変えて調整できます。確認済みの情報と、これから決める内容を分けると、修正のやり取りも進めやすくなります。入力例は利用方法を示すものです。そこで使った数字や架空の設定を、実際の利用者へ引き継ぐことはありません。

結果を使いやすくするコツ

元の文章、正しい固有名詞、確定した条件があれば、そのまま添えてください。計算の対象や根拠の範囲を限定したい時も、最初に指定すると確認しやすくなります。

結果に入れたくない表現や既知の制約も共有してください。名前だけで実装の意味を断定しない。 初稿は、実際の用途と資料に照らして確認し、必要な箇所を修正して使うことを想定しています。

よくある質問

どんな情報や形式を入力できますか?

基本はコードの役割、言語、既存規約、用語、変更範囲です。文章の貼り付けや、内容を取得できる添付資料を使います。URLだけでは本文を確認できない場合は必要な文章も貼り付けてください。取得できなかったファイルやページはその旨を示します。長い資料は、対象範囲や見たい部分も指定してください。

情報が足りなくても始められますか?

作業のテーマが分かれば、任意の条件が足りないだけで止めずに進めます。仮の前提や未確認事項は結果に残し、数字、期限、発言を根拠なく埋めません。必要な元データがない計算や、取得できない事実は未確認として扱います。

自動リネーム機能とどう違いますか?

このAgentは役割と単位、用語に合う名前の候補と対応表を作ります。既存プロジェクトの規約を優先し、リポジトリ全体の名前を実際に変更したとは言いません。Pythonの例ではPEP 8等の公式指針と区別して説明します。

生成や取得に失敗したらどうなりますか?

できた部分を先に返し、未完了の処理と必要な次の入力を説明します。画像やファイルは実際に生成できた結果だけを案内します。修正する際は、対象箇所と変えたい内容を指定してください。

関連するエージェント