Javadocs allow you to generate HTML documentation from your source files. The online API documentation is the result of running a javadoc on the source code of a standard Java library, much like this HTML page here.
To declare a comment as a Javadoc, simply use one of the following notations:
/** Javadoc Comments */ /** Javadoc Comments */ /** * * Javadoc Comments * */
Anything that goes within these comments are valid for Javadoc. To attach the comments to our code, we place them directly before classes, constructors fields, interfaces and methods.
Tags allow Javadoc to know what type of information will follow. Here is a list of common pre-defined tags:
Now that we know the fundamentals of declaring a javadoc and the tags that go with, let's learn how to apply them to a typical class.
Linux for Beginners doesn't make any assumptions about your background or knowledge of Linux. You need no prior knowledge to benefit from this book. You will be guided step by step using a logical and systematic approach. As new concepts, commands, or jargon are encountered they are explained in plain language, making it easy for anyone to understand.$ Check price
Jump start your Java education with Head First Java! This book provides clean diagram examples, with text that is easy-to-understand in an almost too-casual language. Great for anyone new to Java or programming in general.$ Check price