Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Amazon Q Developer vous aide à comprendre votre code et à maintenir la documentation à jour en le générant READMEs pour votre code.
Amazon Q peut produire une nouvelle documentation et mettre à jour la documentation existante dans votre base de code. En analysant votre projet, les objets de code et les dépendances au sein de votre base de code, Amazon Q peut documenter des concepts de codage complexes et mettre à jour la documentation en fonction des nouvelles modifications du code.
Pour générer des documents, vous ouvrez un projet ou un espace de travail dans votre espace de travail IDE et vous entrez /doc
dans le chat. Après avoir choisi le type de mise à jour de la documentation sur laquelle vous souhaitez travailler, Amazon Q analysera votre code, générera de la documentation et fournira une comparaison des modifications apportées. Vous pouvez accepter les modifications proposées ou faire part de vos commentaires concernant les modifications supplémentaires que vous souhaitez qu'Amazon Q apporte.
Pour plus d'informations sur la IDEs prise en charge de cette fonctionnalité, consultezIDEs prises en charge. Pour plus d'informations sur les langues prises en charge, consultezSupport linguistique pour la génération de documentation.
Rubriques
Cas d’utilisation
Amazon Q peut effectuer les tâches suivantes depuis le panneau de discussion duIDE.
-
Création d'une nouvelle documentation : Amazon Q peut créer une nouvelle documentation READMEs pour votre projet en fonction du code contenu dans le dossier sélectionné. Si vous possédez déjà un README et que vous choisissez d'en créer un nouveauREADME, Amazon Q remplacera le vôtre et ne le mettra pas à jour. README Vous avez toujours la possibilité de consulter le nouveau contenu avant qu'Amazon Q ne remplace votre originalREADME.
-
Apporter des mises à jour spécifiques : vous pouvez décrire les modifications que vous souhaitez qu'Amazon Q apporte à votre README compte en langage naturel. Vous pouvez le faire en mettant à jour un existant, README puis en choisissant l'option permettant d'apporter une modification spécifique. Une fois qu'Amazon Q a généré la documentation, vous avez la possibilité de décrire les modifications supplémentaires que vous souhaitez qu'il apporte. Vous pouvez demander des mises à jour, telles que l'ajout d'une section, la suppression d'une section existante ou le développement d'une section existante.
-
Passez en revue le nouveau code et suggérez des mises à jour de la documentation — Une fois que vous avez apporté des modifications au code, Amazon Q peut examiner le nouveau code et suggérer des mises à jour associées à votreREADME.
Types de fichier pris en charge
Amazon Q passe en revue votre code source et vos fichiers de configuration, y compris, mais sans s'y limiter, les types de fichiers suivants, lors de la génération de la documentation :
-
fichiers .template
-
requirements.txt
-
package.json
-
tsconfig.json
-
Dockerfile
-
.git/config
-
LICENSE
-
LICENSE.md
-
CONTRIBUTING
-
CONTRIBUTING.md
Amazon Q filtre les fichiers ou les dossiers définis dans un .gitignore
fichier. Si vous souhaitez exclure des fichiers ou des dossiers de la révision pour la génération de documentation, vous pouvez les inclure dans un .gitignore
fichier de votre projet ou de votre espace de travail.
Quotas
La génération de documentation avec Amazon Q respecte les quotas suivants :
-
READMETaille existante : taille maximale d'un objet existant README qu'Amazon Q peut consulter pour mettre à jour la documentation. Si ce quota est README dépassé, Amazon Q n'est pas en mesure de mettre à jour la documentation existante.
-
Taille du projet de code : taille maximale du projet ou de l'espace de travail qu'Amazon Q peut utiliser pour générer de la documentation.
Même si vous choisissez un dossier plus petit pour lequel générer de la documentation, le projet parent ou l'espace de travail doit respecter ce quota.
-
Générations de documents par tâche : nombre de fois où Amazon Q peut générer de la nouvelle documentation pour une tâche donnée, y compris lors de la génération initiale du document.
Ressource | Quota |
---|---|
READMETaille existante | 15 KO |
Taille du projet de code | 200 Mo non compressés 50 Mo compressés |
Générations de documents par tâche | 3 |