Java: Method returns its own JavaDoc

Question

I would like to write a Java method that returns its own JavaDoc as a String. Is this possible?

eg:

class MyClass{

  /** This method explains itself in a great length and describes 
  the parameters for the   class. It is called whenever the parametrization 
  of that class (based on a config file) is incorrect to remind the user of 
  this class to fix it. */

  public String explain() {
      return "Here simply return the JavaDoc";
  }


 public boolean checkParams(){

    // check parameters
    // call explain if the check went wrong and return false
    // return true if everything went fine.       
 }
}

Answer 1

You can't do that since it is removed from the compiled code. You might use annotations instead and write an annotation processor to read them.