[Même les débutants peuvent le faire! ] Comment écrire Javadoc
1. Connaissances préalables
Ou
En tant que connaissance préalable, le contenu du lien ci-dessus est requis.
2. Qu'est-ce que Javadoc?
- «Javadoc» est un logiciel informatique développé par Sun Microsystems, qui génère des «spécifications API HTML» à partir du code source Java.
- Les commentaires Javadoc sont des
commentairesentre/ ** ʻet* /`.
3. Comment écrire Javadoc et créer de la documentation
Sample.java
/**
* @auteur nom de l'auteur
* @version x.x.x
*/
/**
*Classe principale de commentaire Javadoc
*/
public class Sample {
/**
*méthode principale
* @param args non utilisé
*/
public static void main(String[] args) {
//Affichage de la chaîne de caractères
System.out.println("Exemple JavaDoc");
}
}
- Copiez l'instruction ci-dessus, spécifiez
S-JIScomme code de caractère, enregistrez le nom du fichier sousSample.javaet exécutezjavadoc -d html Sample.javaà l'invite de commande. ↓ ↓
$ javadoc -d html Sample.java
- Le résultat est le suivant.
--Confirmez que le dossier html a été créé.
--Ouvrez ʻindex.htmldans le dossierhtml`.
- Le navigateur démarre et vous verrez
Sample.html.
--S'il est affiché comme l'image, c'est réussi.
4. Connexes
- [Latest] Comment créer un environnement Java sur Ubuntu
- [Même les débutants peuvent le faire! ] Comment créer un environnement Java sous Windows 10 (JDK14.0.1)
- [Même les débutants peuvent le faire! ] Comment installer Eclipse sur Windows 10 (construction de l'environnement Java)
Recommended Posts