翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
Amazon Q Developer を使用したドキュメントの生成
Amazon Q Developer は、コードREADMEsの を生成することで、コードを理解し、ドキュメントを最新の状態に保つのに役立ちます。
Amazon Q は、コードベースで新しいドキュメントを作成し、既存のドキュメントを更新できます。プロジェクト、コードオブジェクト、コードベース内の依存関係を分析することで、Amazon Q は複雑なコーディングの概念を文書化し、新しいコード変更に基づいてドキュメントを更新できます。
ドキュメントを生成するには、 でプロジェクトまたはワークスペースを開きIDE、チャット/docに と入力します。作業するドキュメント更新のタイプを選択すると、Amazon Q はコードを分析し、ドキュメントを生成し、変更点を提供します。提案された変更を承諾するか、Amazon Q に指示する追加の変更についてフィードバックを提供できます。
この機能IDEsでサポートされる の詳細については、「」を参照してくださいサポートされている IDEs。サポートされている言語の詳細については、「」を参照してくださいドキュメント生成の言語サポート。
トピック
ユースケース
Amazon Q は、 のチャットパネルから次のタスクを実行できますIDE。
-
新しいドキュメントの作成 – Amazon Q は、選択したフォルダのコードに基づいてREADMEsプロジェクトの新しい を作成できます。が既にありREADME、新しい を作成することを選択した場合README、Amazon Q は既存の を上書きしREADME、更新しません。Amazon Q が元の を上書きする前に、新しいコンテンツを確認するオプションがありますREADME。
-
特定の更新を行う – Amazon Q で に加える変更をREADME自然言語で記述できます。そのためには、既存の を更新しREADME、特定の変更を行うオプションを選択します。Amazon Q がドキュメントを生成したら、追加で加える変更を記述するオプションがあります。セクションの追加、既存のセクションの削除、既存のセクションの詳細化などの更新をリクエストできます。
-
新しいコードを確認し、ドキュメントの更新を提案する – コードを変更すると、Amazon Q は新しいコードを確認し、関連する更新を に提案できますREADME。
[サポートされているファイルの種類]
Amazon Q は、ドキュメントを生成するときに、以下のファイルタイプを含むがこれに限定されないソースコードと設定ファイルを確認します。
-
.template ファイル
-
requirements.txt
-
package.json
-
tsconfig.json
-
Dockerfile
-
.git/config
-
LICENSE
-
LICENSE.md
-
CONTRIBUTING
-
CONTRIBUTING.md
Amazon Q は、ファイルで定義された.gitignoreファイルまたはフォルダを除外します。ドキュメント生成のレビュー対象から除外するファイルまたはフォルダがある場合は、プロジェクトまたはワークスペースの.gitignoreファイルにそれらを含めることができます。
クォータ
Amazon Q によるドキュメント生成では、次のクォータが維持されます。
-
既存のREADMEサイズ – Amazon Q READMEがドキュメントを更新するために確認できる既存の の最大サイズ。がこのクォータREADMEを超えると、Amazon Q は既存のドキュメントを更新できません。
-
コードプロジェクトサイズ – Amazon Q がドキュメントの生成に使用できるプロジェクトまたはワークスペースの最大サイズ。
ドキュメントを生成する小さいフォルダを選択した場合でも、親プロジェクトまたはワークスペースはこのクォータ内である必要があります。
-
タスクあたりのドキュメント生成 – Amazon Q が特定のタスクの新しいドキュメントを生成できる回数。最初のドキュメント生成を含む。
| リソース | クォータ |
|---|---|
| 既存のREADMEサイズ | 15 KB |
| コードプロジェクトサイズ | 200 MB (非圧縮) 50 MB (圧縮) |
| タスクあたりのドキュメント生成数 | 3 |
