javadoc

[davidh38]

Wenn ich mich in meinem Kommentar auf die Variable hallo beziehen möchte, muss ich dann ein @ davorsetzen? Etwa wie hier:

/**
* Die Variable @hallo dient blablubb
*
* @param hallo
**/

Oder ist das @ unnsinnig vor dem hallo?

 

[insane80]

Wenn "hallo" ein Parameter für einen Konstruktor / eine Methode ist, dann sollte das schon passen.

 

[davidh38]

Wenn "hallo" ein Parameter für einen Konstruktor / eine Methode ist, dann sollte das schon passen.

Ich habe mal nachgeschaut, sie wir aber durch das @ jetzt nicht anders gekennzeichnet, es steht dann da wie im plain text @hallo.

 

[insane80]

Ich weiß nicht genau, wie Du das meinst...

Z.B.:

/**
     * @param hallo  Ein String
     */
     public void meineMethode(String hallo)
     {
         //Code
     }

JavaDoc sieht dann folgendermaßen aus:

 

[Illuvatar]

Also, das hier wurde zum Beispiel so gemacht:

    /**
     * Initializes a newly created {@code String} object so that it represents
     * the same sequence of characters as the argument; in other words, the
     * newly created string is a copy of the argument string. Unless an
     * explicit copy of {@code original} is needed, use of this constructor is
     * unnecessary since Strings are immutable.
     *
     * @param  original
     *         A {@code String}
     */

 

[Beni]

Ich mache das immer mit den code tags:

/** Die Variable <code>hallo</code> macht... */