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

Uso de AI Code Documenter

Escrito para la antigua interfaz de usuario

Resumen

Este artículo explica cómo usar AI Code Documenter para generar automáticamente documentación para un componente seleccionado. Ayuda a los equipos a crear documentación de código clara y bien estructurada que puedes confirmar en la rama.

Limitaciones predeterminadas de la IA

De forma predeterminada, Flosum proporciona un modelo de IA DeepSeek compartido gratuito para DevOps a través de la API de DeepSeek. Debido a que se comparte entre inquilinos, el rendimiento y la disponibilidad dependen de la carga del sistema y de la capacidad de tokens. Durante un uso intensivo, es posible que vea una mayor latencia o errores temporales. Para evitar esto, puede agregar su propio modelo de IA personalizado. Consulte el siguiente artículo.

Buenas prácticas

  • Ejecuta AI Code Documenter sobre código estable para evitar regenerar comentarios repetidamente.

  • Revisa siempre los comentarios de IA antes de confirmar para garantizar la precisión y la terminología correcta.

  • Confirma en fragmentos pequeños y lógicos para mantener sencilla la revisión y la reversión.

Uso de AI Code Documenter

1

Seleccione una rama y un componente

  1. Haz clic en Código desde el menú de la barra lateral izquierda.

  2. Haz clic en la rama que contiene el componente que quieres documentar.

  3. Haz clic en el componente que quieres documentar.

2

Crear documentación

  1. Haz clic en Herramientas de IA junto a Editar.

  2. Haz clic en AI Code Documenter en el menú desplegable.

  3. Mientras se genera la documentación, La IA está generando... se muestra.

  4. Cuando AI Code Documenter termina, se abre el visor de diferencias, con el original a la izquierda y los cambios de IA a la derecha.

  5. Revisa los cambios y realiza cualquier edición necesaria.

  6. Haz clic en Confirmar cambios.

  7. Introduce un mensaje de commit.

  8. Haz clic en Confirmar.

Última actualización

¿Te fue útil?