Hi guys,I 憊e been asked to justify my source code in Java using Javadoc.For every exercise I have to include all the .html files which are produced fromJavadoc and the clients programs which they use the operations of the programs.
Could anybody help me,tell me what Javadoc is give me some advice how I have to do it?
Javadoc is an application, and a method of commenting your code (something you should be doing). See [url=http://java.sun.com/j2se/1.4.2/docs/api/]this[/url] for an example of the output.
i.e.
/** I am a oneliner
* More text
* <b>html</b>
* @param client The client to process
* @return The BigglesMonkey
*/
public void BigglesMonkey processClient( Client client ) { ... }
[url=http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html]Application Documentation[/url]
[url=http://www.google.co.uk/search?q=javadoc+tutorial&start=0&ie=utf-8&oe=utf-8&client=firefox-a&rls=org.mozilla:en-US:official]Helpful link[/url]
> Recommendation: Download a good IDE (e.g., Eclipse,
> http://www.eclipse.org), which automates Javadoc
> creation for you so you can concentrate on more
> important things (like coding!)
I'm sorry, but NO ide can write your comments for you. They could put the basics down, but that is a small part of the comments.
Also, if the OP does not know what javadocs are, if is a fair guess that they are new to Java, in which case I would recomend they do not use an IDE.
Thank you all for your help!
Well i use Linux in my uni and now I'm away from there and I'm connected through telnet with one of the Sun OS boxes.
I have created the html files(with javadoc) i execute
firefox My_program.html and the message is Gtk-WARNING **: cannot open display:.
How am i supposed to open it?
Right now,my pc runs Windows and i have a black console in front of me(the telnet staff).
Can anybody help me?
Thanks in advance!
