Menu
Possible Duplicate:
Does “/* (non-javadoc)” have a well-understood meaning?
What does the following statements mean?
/* (non-Javadoc) * * Standard class loader method to load a class and resolve it. * * @see java.lang.ClassLoader#loadClass(java.lang.String) */ @SuppressWarnings("unchecked") 
815
In general, Javadoc comments are any multi-line comments (" /** ... */ ") that are placed before class, field, or method declarations. They must begin with a slash and two stars, and they can include special tags to describe characteristics like method parameters or return values.
Documentation comments (known as "doc comments") are Java-only, and are delimited by /**... */ . Doc comments can be extracted to HTML files using the javadoc tool. Implementation comments are meant for commenting out code or for comments about the particular implementation.
Before using JavaDoc tool, you must include JavaDoc comments /**……………….. */ providing information about classes, methods, and constructors, etc. For creating a good and understandable document API for any java file you must write better comments for every class, method, constructor.
Javadoc looks for comments that start with /**. By tradition, method comments that are not intended to be part of the java docs start with "/* (non-Javadoc)" (at least when your dev environment is Eclipse).
As an aside, avoid using multi-line comments inside methods. For example, avoid this:
public void iterateEdges() { int i = 0; /* * Repeat once for every side of the polygon. */ while (i < 4) { } } The following is preferred:
public void iterateEdges() { int i = 0; // Repeat once for every side of the polygon. while (i < 4) { ++i; } } The reason is that you open the possibility to comment out the entire method:
/* public void iterateEdges() { int i = 0; // Repeat once for every side of the polygon. while (i < 4) { ++i; } } */ public void iterateEdges() { // For each square edge. for (int index = 0; index < 4; ++index) { } } Now you can still see the old method's behaviour while implementing the new method. This is also useful when debugging (to simplify the code).
62
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
