Wie schreibe ich Javadoc für eine getInstance-Methode?

Question

sagen, dass ich so etwas wie dieses:

public class MyClass { 
    private static MyClass sInstance; 

    /** 
    * 
    * @return The {@link MyClass} application instance. 
    */ 
    public static MyClass getInstance() { 
     return sInstance; 
    } 
} 

IntelliJ gibt mir diese Warnung:

'@link' zu enthalten Klasse zeigen, ist nicht notwendig

Was die richtige/herkömmliche Art und Weise ist um dieses Stück Javadoc zu schreiben?

Wie würden Sie es schreiben?

Answer 1

Im JDK verwenden sie {@code}. Das macht keinen klickbaren Link, aber Sie schauen sich schon die Seite an, die sowieso verlinkt wäre.

Zum Beispiel (von String.java):

/** 
    * 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} 
    */ 

Answer 2

Sie nur die Warnung erhalten, weil die Verbindung nicht überall gehen. Ändern Sie es einfach in {@code MyClass}, um die Formatierung zu behalten, aber ohne den Link.

Hier sind einige Beispiele getInstance() Methoden aus dem JDK.

java.text.Collator:

/** 
* Gets the Collator for the current default locale. 
* The default locale is determined by java.util.Locale.getDefault. 
* @return the Collator for the default locale.(for example, en_US) 
* @see java.util.Locale#getDefault 
*/ 
public static synchronized Collator getInstance() { 

java.text.NumberFormat:

/** 
* Returns a general-purpose number format for the current default 
* {@link java.util.Locale.Category#FORMAT FORMAT} locale. 
* This is the same as calling 
* {@link #getNumberInstance() getNumberInstance()}. 
* 
* @return the {@code NumberFormat} instance for general-purpose number 
* formatting 
*/ 
public final static NumberFormat getInstance() {