Apoyo lingüístico y normas

La siguiente tabla enumera los lenguajes de código y la norma de documentación correspondiente para cada lenguaje de código.

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 generar documentación

Puede utilizar el comando ' /document ' en el chat para generar documentación para un archivo referenciado o un método o una clase en el área de trabajo activa.

Utilice esta sintaxis:

/document <code reference> [additional instructions]

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

• Para ' <code reference>, escriba el símbolo ' @ para ver una lista de archivos, clases y métodos de su espacio de trabajo. Utilice un archivo, método o referencia de clase cada 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 generar documentación

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

1. Haga clic en la opción Documento que precede inmediatamente a un bloque o fragmento de código para generar su documentación.

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

   

2. La ventana de chat watsonx Code Assistant se abre, muestra el comando ' /document @<*item name*>, ejecuta el comando y muestra el código con la documentación añadida como comentarios.