Ctrlk
Kundensupport
For the complete documentation index, see llms.txt. This page is also available as Markdown.

KI-Code-Dokumenter verwenden

Geschrieben für die alte Benutzeroberfläche

Dieser Artikel wurde für die alte Benutzeroberfläche geschrieben. Die Anweisungen sind weiterhin verwendbar, aber die Screenshots sind veraltet. In einigen Fällen wurden die in den Anweisungen genannten Elemente verschoben oder geändert. Wenn Sie ein Element nicht finden können, siehe den Wo ist es hin Artikel.

Überblick

Dieser Artikel erklärt, wie der AI Code Documenter verwendet wird, um automatisch Dokumentation für eine ausgewählte Komponente zu generieren. Er hilft Teams dabei, klare, gut strukturierte Code-Dokumentation zu erstellen, die Sie in den Branch committen können.

Standardmäßige KI-Einschränkungen

Standardmäßig stellt Flosum über die API von DeepSeek ein kostenloses gemeinsam genutztes DeepSeek-KI-Modell für DevOps bereit. Da es mandantenübergreifend gemeinsam genutzt wird, hängen Leistung und Verfügbarkeit von der Systemauslastung und der Token-Kapazität ab. Bei hoher Nutzung kann es zu höherer Latenz oder vorübergehenden Fehlern kommen. Um dies zu vermeiden, können Sie Ihr eigenes benutzerdefiniertes KI-Modell hinzufügen. Siehe den folgenden Artikel.

Bewährte Vorgehensweisen

  • Führen Sie AI Code Documenter auf stabilem Code aus, um zu vermeiden, dass Kommentare wiederholt neu generiert werden.

  • Überprüfen Sie AI-Kommentare immer vor dem Commit, um Genauigkeit und die korrekte Terminologie sicherzustellen.

  • Committen Sie in kleinen, logischen Blöcken, damit Überprüfung und Rollback einfach bleiben.

Verwendung von AI Code Documenter

1

Branch und Komponente auswählen

  1. Klicken Sie auf Code über das Menü in der linken Seitenleiste.

  2. Klicken Sie auf den Branch, der die Komponente enthält, die Sie dokumentieren möchten.

  3. Klicken Sie auf die Komponente, die Sie dokumentieren möchten.

2

Dokumentation erstellen

  1. Klicken Sie auf KI-Tools neben Bearbeiten.

  2. Klicken Sie auf AI Code Documenter im Dropdown-Menü aus.

  3. Während die Dokumentation generiert wird, KI wird generiert... angezeigt.

  4. Wenn AI Code Documenter fertig ist, öffnet sich die Diff-Ansicht, mit dem Original links und den KI-Änderungen rechts.

  5. Überprüfen Sie die Änderungen und nehmen Sie gegebenenfalls erforderliche Bearbeitungen vor.

  6. Klicken Sie auf Änderungen übernehmen.

  7. Geben Sie eine Übermittlungsnachricht.

  8. Klicken Sie auf Übernehmen.

VorherigeKI-Testklasse verwenden
NächsteDevOps CLI

Zuletzt aktualisiert

War das hilfreich?