Felo
コードの日本語コメント・技術文書AI
コードの日本語コメント・技術文書AIとは？
動作を変えずに意図が分かるコメント、関数説明、利用例を作ります。 コードの意図を引き継ぎたい開発者が、手元の情報から次の作業へ進めるよう、入力の整理と結果づくりを一つの対話で行います。
コードの日本語コメント・技術文書AIでは、曖昧な依頼に長い質問票を返すより、分かる範囲で初稿を作ることを優先します。必要なテーマが完全にない場合だけ、最初の情報を一つ伺います。
コードの日本語コメント・技術文書AIでできること
- コメント付きコード： 入出力、依存、副作用、エラー、分かる設計意図をコードから抽出する。
- 関数・モジュール説明： 明らかな構文の繰り返しを避け、理由、前提、不変条件にコメントを置く。
- 利用例： docstringや引数・戻り値・例外の説明、利用例を作る。
- 推定・未確認の意図： 元コードとの差分を照合し、動作変更がないことと推定した意図を分ける。
使い方
- コード、想定読者、公開したい関数、背景資料を入力してください。ファイルを添付した場合は「開始」と入力して進めます。
- 対象者、用途、希望する長さや形式が決まっていれば添えてください。未確定の条件は、未確定と書いておけば大丈夫です。
- 結果と確認事項を見て、「この部分を短く」「表の項目を変えて」など、変更したい箇所を指定してください。
入力例と利用場面
そのまま試せる入力例
Python関数を貼ります。初学者への引継ぎ用に日本語docstringと必要なコメントを追加してください。挙動は変えないでください。
返す内容の例
元の処理文を保持し、例外や入力条件は確認できる範囲だけ説明。
使い分け
対象のコードと使用環境を共有し、出力を確認して対象範囲や説明の詳しさを調整できます。確認済みの情報と、これから決める内容を分けると、修正のやり取りも進めやすくなります。入力例は利用方法を示すものです。そこで使った数字や架空の設定を、実際の利用者へ引き継ぐことはありません。
結果を使いやすくするコツ
元の文章、正しい固有名詞、確定した条件があれば、そのまま添えてください。計算の対象や根拠の範囲を限定したい時も、最初に指定すると確認しやすくなります。
結果に入れたくない表現や既知の制約も共有してください。作者の意図を根拠なく断定しない。 初稿は、実際の用途と資料に照らして確認し、必要な箇所を修正して使うことを想定しています。
よくある質問
どんな情報や形式を入力できますか？
基本はコード、想定読者、公開したい関数、背景資料です。文章の貼り付けや、内容を取得できる添付資料を使います。URLだけでは本文を確認できない場合は必要な文章も貼り付けてください。取得できなかったファイルやページはその旨を示します。長い資料は、対象範囲や見たい部分も指定してください。
情報が足りなくても始められますか？
作業のテーマが分かれば、任意の条件が足りないだけで止めずに進めます。仮の前提や未確認事項は結果に残し、数字、期限、発言を根拠なく埋めません。必要な元データがない計算や、取得できない事実は未確認として扱います。
ChatGPTなどの汎用AIチャットとの違いは？
コードの日本語コメント・技術文書AIは、コメント付きコードから推定・未確認の意図までを、今回の用途に合わせた決まった流れで整理します。他のサービスの全機能や管理画面を再現するものではありません。コメント追加のために処理やAPIを勝手に変えない。
生成や取得に失敗したらどうなりますか？
できた部分を先に返し、未完了の処理と必要な次の入力を説明します。画像やファイルは実際に生成できた結果だけを案内します。修正する際は、対象箇所と変えたい内容を指定してください。