7
votes

Documentation Java

Je ne suis pas en mesure de créer une documentation pour ce code, je pense que mon coomadien de Javadoc n'est pas correct, je l'ai lu mais je ne comprends pas, peut-être que quelqu'un ne peut corriger par Javadoc Cammand XXX PRE>

Error:
C:\Program Files\Java\jdk1.6.0\bin>javac abc.java

C:\Program Files\Java\jdk1.6.0\bin>java abc
documentation

C:\Program Files\Java\jdk1.6.0\bin>javadoc abc
Loading source files for package abc...
javadoc: warning - No source files for package abc
Constructing Javadoc information...
javadoc: warning - No source files for package abc
javadoc: error - No public or protected classes found to document.
1 error
2 warnings


1 commentaires

Avez-vous lu le message d'erreur ?


3 Réponses :


3
votes

Comme le message d'erreur indique clairement, Javadoc crée une documentation pour public ou classes et méthodes (membres visibles de l'extérieur de votre colis).

Vous n'en avez pas.

En outre, Javadoc prend un Package (dossier ou fichier jar), pas un nom de classe.


1 commentaires

Le problème n'est pas que ce n'est pas public, mais qu'il n'y a pas de fichiers source dans le paquet .



8
votes

Dans votre cas, vous voudriez fournir le nom du fichier au lieu d'un nom de package.

/**
 * class documentation here
 */
public class abc
{

    /** 
     * method documentation here 
     */
    public static void main(String a[])
    {
      /**
       * this will be ignored.
       */
       System.out.println("documentation");
    }

}


0 commentaires

3
votes

C'est vieux, je sais, mais j'ai trouvé une solution qui a fonctionné pour moi. Ce n'est pas basé sur un paquet, mais cela m'a fallu pour toujours pour le comprendre, alors je pensais que je le partageais: xxx

L'option privée est la clé ici.


0 commentaires