Amazon Q Developer を使用したドキュメント生成のベストプラクティス - Amazon Q Developer

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Amazon Q Developer を使用したドキュメント生成のベストプラクティス

Amazon Q を使用したドキュメント生成の結果を改善するには、次のベストプラクティスに従います。

  • Amazon Q は、コードプロジェクトのサイズクォータ内の任意の量のコードのドキュメントを生成できますが、非常に大きなリポジトリでは のドキュメントの生成に時間がかかり、詳細ではない場合があります。大規模なリポジトリがある場合は、より具体的な結果を得るために、コードのサブセットまたは 1 つのファイルのドキュメントをリクエストすることを検討してください。

  • Amazon Q が生成するドキュメントの品質は、コードのコメントと整理が良好で、プログラミングエンティティの命名規則が良好で、他の標準コーディング規則に従っている場合に向上する可能性があります。

  • Amazon Q は、サポートされている 1 つ以上の言語で記述されたコードについて、最高品質のドキュメントを作成します。他の言語で記述されたコードは、生成されたドキュメントに反映されないか、品質の低いドキュメントを生成する可能性があります。言語の詳細については、「」を参照してくださいドキュメント生成の言語サポート。

  • README 自然言語で に特定の変更をリクエストする場合は、既存の を更新してからREADME、特定の変更を行うオプションを選択します。Amazon Q がドキュメントを生成したら、変更を加えることを選択し、Amazon Q が実行する更新を記述することもできます。

  • Amazon Q でドキュメントに加える更新を記述する場合は、次の点を考慮してください。

    • 変更の説明には、変更するセクション、追加または削除するコンテンツ、修正が必要な特定の問題を含める必要があります。

    • 変更は、プロジェクト機能を に反映する方法に関連している必要がありますREADME。

    • 参照するコンテンツは、コードベースで利用できる必要があります。

  • Amazon Q は、プライベートまたは内部プラットフォームにアクセスできません。Amazon Q は、コード内のサードパーティー製ツールやソフトウェア、または特殊なツールに関する知識がない場合もあります。コードに Amazon Q がアクセスできないリソースが含まれている場合、または Amazon Q に慣れていない場合、そのコードは文書化されません。を手動で編集READMEして、Amazon Q が生成できないコンテンツを含めることができます。