Explicación del código

watsonx Code Assistant

Utilice la IA generativa para analizar y resumir su código y comprender lo que hace.

En el cuadro siguiente figura el tipo de explicación de cada plan.

Tipos de explicación
Plan Explicación Descripción
Plan de prueba " Plan Essentials Básico Utiliza la IA generativa para ofrecer una explicación básica. No es necesario un análisis adicional del código.
Plan Estándar Mejorado Requiere una aplicación construida, y utiliza un análisis de código y una IA generativa para proporcionar una explicación de código mejorada para métodos/clases Java y aplicaciones Java empresariales.

Sólo Eclipse IDE: Para obtener los mejores resultados con una aplicación Java multimódulo, asegúrese de importar el módulo agregador y cada submódulo como proyectos independientes dentro del espacio de trabajo Eclipse. es poco probable que Watsonx Code Assistant introspeccione correctamente su proyecto si importa el directorio de nivel superior como un único proyecto.

Soporte de idiomas

La explicación del código está disponible para los siguientes idiomas:

  • C
  • C++
  • Go
  • Java
  • JavaScript
  • Python
  • TypeScript

Cuando se hace referencia a un método, o se utiliza CodeLens en un método, watsonx Code Assistant admite determinados lenguajes de código. La referencia a un archivo completo funciona en todos los idiomas. Para obtener más información, consulte Ayuda lingüística al trabajar con métodos.

Utilizar un comando de chat para explicar el código

Puede utilizar el comando ' /explain ' en el chat para explicar el código de una clase, archivo, función o método referenciado en el área de trabajo activa.

Utilice esta sintaxis:

/explain <code reference> [additional instructions]

  • Asegúrese de iniciar la consulta con /explain, seguido del resto de la sintaxis.

  • Para ' <code reference>, escriba el símbolo ' @ para ver una lista de clases, archivos, funciones y métodos de su espacio de trabajo. Utilice una referencia de clase, archivo, función o método a la vez.

  • Los ' [additional instructions] ' son opcionales. Añada instrucciones si desea detalles específicos.

Al hacer referencia a un archivo, el límite de tamaño es de 50 KB. Si alcanza este límite, divida el archivo en funciones individuales y haga referencia a cada una de ellas. O divida el archivo en 49 KB, teniendo en cuenta los límites de las funciones, y haga referencia al archivo en cada división. Con cualquiera de los dos métodos, hay que fusionar los resultados.

Uso de CodeLens en el editor para explicar el código

En el editor IDE, CodeLens muestra una línea de opciones de IA generativa que precede a los bloques y fragmentos de código.

Problema conocido Si utiliza la extensión watsonx Code Assistant for Enterprise Java Applications, al iniciarse puede que las funciones Java mejoradas tarden unos segundos en estar disponibles en CodeLens.

  1. Haga clic en la opción Explicar que precede inmediatamente a un bloque de código para generar una explicación.

    En el siguiente ejemplo de código, las opciones " Explain | Document | Unit Test " preceden inmediatamente a las palabras clave " protected void ".

    CodeLens ejemplo
    CodeLens ejemplo

  2. La ventana de chat watsonx Code Assistant se abre, muestra el comando ' /explain @<*item name*>, ejecuta el comando y muestra la explicación.

Desactivación de CodeLens

Si desea desactivar las opciones de CodeLens, puede cambiar la configuración de la extensión o complemento.

En Visual Studio Code:

  1. Abra la configuración de la extensión.

  2. Borre la configuración de Enable CodeLens.

En Eclipse:

  1. Abra la configuración de Eclipse IDE.

  2. En la entrada watsonx Code Assistant Settings, desactive la opción Enable CodeLens.

  3. Haga clic en Aplicar y cierre.

Utilizar el explorador para explicar el código

Para generar una explicación desde el Explorador ( Visual Studio Code ) o el Explorador de proyectos ( Eclipse ):

  1. Amplíe su aplicación al código para el que desea generar una explicación.

  2. Haga clic con el botón derecho en el código, haga clic en watsonx Code Assistant y, a continuación, haga clic en Explicar.

  3. El chat watsonx Code Assistant muestra el comando ' /explain ' para el código seleccionado. En el comando se utiliza la siguiente sintaxis:

    /explain <code syntax>

  4. Watsonx Code Assistant procesa la solicitud y en el chat muestra la explicación del código seleccionado.

Explicación de las aplicaciones Java

Plan estándar La explicación de la aplicación sólo está disponible con la extensión watsonx Code Assistant for Enterprise Java Applications.

La explicación de la aplicación sólo es compatible con aplicaciones Java que contengan una o más clases que extiendan ' javax.servlet.http.HttpServlet. Estas clases deben implementar cualquiera de los siguientes métodos: ' doGet, ' doPost, o ' doPut.

Para aplicaciones grandes, la explicación considera los 40 puntos de entrada con mayor complejidad ciclomática. Si la solicitud supera los 40 puntos de entrada, la explicación contiene la sección The following methods were not considered: en la que se detallan los puntos de entrada que no se han tenido en cuenta.

Para solicitar y ver una explicación de una solicitud:

  1. En su IDE, haga clic con el botón derecho en cualquier elemento de la jerarquía del directorio de la aplicación que desea explicar y, a continuación, haga clic en Explicar aplicación.

    En el Eclipse IDE, si tiene una aplicación multimódulo con una raíz multimódulo par, la explicación de la aplicación sólo se aplica al módulo seleccionado.

  2. Watsonx Code Assistant analiza la aplicación para generar una descripción general y una lista de los principales servicios con una descripción de las funciones de cada método.

  3. Haga clic en Guardar para conservar una copia o se descartará la explicación.

  4. Haga clic en Abrir explicación y revísela; a continuación, puede hacer clic en Guardar explicación de la aplicación para guardarla en un archivo local.