eclipse - Java 'project manager'? (comments, class view, etc...) -
Reading the files of some open source Java projects, I think I am not using all the advantages of the current developer tools Has to offer.
Commentaries are often included in:
@complete @ returns {@link * classname *}
etc.
Is this the only 'good' style / best practice or does it mean that the developer has used some kind of device to make its code easier for others to read? If so, can you start with some recommendations?
I am currently using a very light version of eclipse and thought it would be enough, but if it is the common way of using such tools, most programmers use it, There are good reasons for this.
This is a syntax that creates a document for your Java classes. Since you are still using Eclipse, do this:
- Click on "Window" -> "View" -> "Other" -> Type "javadoc".
- Open Jadavo Opinion This view shows you how documents will be provided after all.
Now open any of your classes and type "/ **" at the top of the class definition and press enter. You will see something like this:
/ ** * * / public class mylas ...
This behaves like a multilayer comment, But always starts with a double estheik carat in this block, keep the CRTL and the hit space. This will show you all the acceptable tags, which you can use to mark up the document. Write a "@" sign and do this to see all predefined javadoc tags. Add some of these, and see how the jvadak scene is changing.
When you have done, click on "Project" -> "Create Javascript" -> "Finish". Your project will have a folder called "Docs", where you can find the document. Open index.html in your browser.
Comments
Post a Comment