Soutien et normes linguistiques

Le tableau suivant répertorie les langues de code et la norme de documentation correspondante pour chaque langue de code.

Lorsque vous faites référence à une méthode ou que vous utilisez CodeLens sur une méthode, watsonx Code Assistant prend en charge certains langages de code. La référence à un fichier complet fonctionne pour toutes les langues. Pour plus d'informations, voir Assistance linguistique lorsque vous travaillez avec des méthodes.

Utilisation d'une commande de chat pour générer de la documentation

Vous pouvez utiliser la commande '/document dans le chat pour générer la documentation d'un fichier référencé, d'une méthode ou d'une classe dans l'espace de travail actif.

Utilisez la commande suivante :

/document <code reference> [additional instructions]

• Veillez à commencer l'invite par /document, suivi du reste de la syntaxe.

• Pour " <code reference>, tapez le symbole " @ pour obtenir une liste de fichiers, de classes et de méthodes de votre espace de travail. Utilisez un fichier, une méthode, une référence de classe à la fois.

• Le " [additional instructions] est facultatif. Ajoutez des instructions si vous souhaitez des détails spécifiques.

Lorsque vous faites référence à un fichier, la taille maximale est de 50 KB. Si vous atteignez cette limite, divisez le fichier en fonctions individuelles et faites référence à chaque fonction. Vous pouvez également diviser le fichier en 49 Ko, en tenant compte des limites des fonctions, et faire référence au fichier à chaque division. Quelle que soit l'approche retenue, il faut fusionner les résultats.

Utiliser le CodeLens dans l'éditeur pour générer de la documentation

Dans l'éditeur IDE, CodeLens affiche une ligne d'options d'IA générative qui précède les blocs de code et les extraits.

1. Cliquez sur l'option Document qui précède immédiatement un bloc de code ou un extrait pour générer sa documentation.

   Dans l'exemple de code suivant, les options " Explain | Document | Unit Test précèdent immédiatement les mots-clés " protected void.

   

2. La fenêtre de discussion watsonx Code Assistant s'ouvre, affiche la commande '/document @<*item name*>, exécute la commande et affiche le code avec la documentation ajoutée sous forme de commentaires.