Bewährte Methoden für die Dokumentationserstellung mit Amazon Q Developer - Amazon Q Developer

Bewährte Methoden für die Dokumentationserstellung mit Amazon Q Developer

Halten Sie sich an die folgenden bewährten Methoden, um die Ergebnisse der Dokumentationserstellung mit Amazon Q zu verbessern:

  • Amazon Q kann Dokumentation für jede Codemenge innerhalb des Größenkontingents für Codeprojekte generieren. Bei sehr großen Repositorys dauert die Generierung der Dokumentation jedoch länger und ist möglicherweise weniger spezifisch. Wenn Sie über ein großes Repository verfügen, sollten Sie erwägen, Dokumentation für eine Teilmenge des Codes oder eine einzelne Datei anzufordern, um genauere Ergebnisse zu erzielen.

  • Die Qualität der von Amazon Q generierten Dokumentation kann verbessert werden, wenn Ihr Code gut kommentiert und organisiert ist, gute Benennungskonventionen für Programmierentitäten hat und andere Standardcodierungskonventionen befolgt.

  • Amazon Q erstellt die qualitativ hochwertigste Dokumentation für Code, der in einer oder mehreren der unterstützten Sprachen geschrieben wurde. In anderen Sprachen geschriebener Code spiegelt sich möglicherweise nicht in der generierten Dokumentation wider oder kann zu einer Dokumentation von geringerer Qualität führen. Weitere Informationen erhalten Sie unter Unterstützte Sprachen für Amazon Q Developer in der IDE.

  • Wenn Sie bestimmte Änderungen an einer README-Datei in natürlicher Sprache anfordern möchten, wählen Sie zunächst die Option zum Aktualisieren einer bestehenden README-Datei und dann die Option zum Vornehmen einer bestimmten Änderung aus. Nachdem Amazon Q die Dokumentation generiert hat, können Sie sich auch dafür entscheiden, Änderungen vorzunehmen und zu beschreiben, welche Aktualisierungen Amazon Q vornehmen soll.

  • Beachten Sie bei der Beschreibung der Aktualisierungen, die Amazon Q an Ihrer Dokumentation vornehmen soll, Folgendes:

    • Die Beschreibung der Änderungen sollte die Abschnitte enthalten, die Sie ändern möchten, den Inhalt, den Sie hinzufügen oder entfernen möchten, sowie spezifische Probleme, die behoben werden müssen.

    • Die Änderungen sollten sich darauf beziehen, wie die Projektfunktionen in der README-Datei wiedergegeben werden.

    • Der Inhalt, auf den Sie sich beziehen, sollte in Ihrer Codebasis verfügbar sein.

  • Amazon Q hat keinen Zugriff auf private oder interne Plattformen. Amazon Q hat möglicherweise auch keine Kenntnisse über Tools oder Software von Drittanbietern oder spezielle Tools in Ihrem Code. Wenn Ihr Code Ressourcen enthält, auf die Amazon Q nicht zugreifen kann oder mit denen Amazon Q nicht vertraut ist, wird dieser Code nicht dokumentiert. Sie können die README-Datei manuell bearbeiten, um Inhalte aufzunehmen, die Amazon Q nicht generieren kann.