Comment référencer correctement des méthodes en Javadoc et qu'est-ce que {@link} ?
Bonjour à tous ! Je viens de commencer à apprendre Java et j'écris la documentation pour mon projet. J'ai rencontré un problème : je veux faire un lien vers une autre méthode dans les commentaires Javadoc pour faciliter la lecture de la documentation. Par exemple, j'ai une classe `Calculator` avec les méthodes `add()` et `sumAndPrint()`. Dans la deuxième méthode, je veux indiquer dans la description qu'elle appelle `add()`.
J'ai essayé d'écrire simplement `#add` ou `{@link add}`, mais cela ne fonctionne pas — le lien ne s'affiche pas dans la documentation HTML générée. Dans la documentation officielle, il est question de `{@link #methodName}`, mais je ne comprends pas comment spécifier correctement le chemin complet si la méthode se trouve dans une autre classe ou avec des paramètres.
Voici un exemple de mon code :
```java
/**
* Calculatrice pour les opérations arithmétiques simples.
*/
public class Calculator {
/**
* Additionne deux nombres.
* @param a le premier nombre
* @param b le deuxième nombre
* @return la somme de a et b
*/
public int add(int a, int b) {
return a + b;
}
```
No answers yet.
Connectez-vous pour laisser une réponse