Can someone please tell me how to write the description of a class with an eg . Please I am not able to understand. I asked his question on StackExchange but they have still not answered it well -_-. Please help.
In the beginning of a class this documentation comment appears :
/**
* Write a description of class Book here.
*
* @author (your name)
* @version (a version number or a date)
*/
obviously I know how to write author and version but what to write in the class description.
Post by:Tim Cooke
, Marshal
Your question is quite vague which may be why you haven't received a satisfactory answer.
Can you expand on exactly what you mean by "write a description of a class"? Are you trying to actually write a Java class? If so, what should it do? If not, then I don't know what you're asking.
Post by:Dave Tolls
, Rancher
All that needs is a description of what the Book class represents and what it does.
Post by:Manaf Abdul
, Greenhorn
Dave Tolls wrote:All that needs is a description of what the Book class represents and what it does.
so can you give an example if it's so simple ??
Post by:Tim Cooke
, Marshal
Only you know what your Book class does, so only you can describe it. What you have there is JavaDoc and serves as documentation of your software so the Java compiler doesn't care what you write in there, it only serves as documentation for others to understand the purpose of that class in the context of your application. Write a description that conveys that information.
Post by:Manaf Abdul
, Greenhorn
Tim Cooke wrote:Only you know what your Book class does, so only you can describe it. What you have there is JavaDoc and serves as documentation of your software so the Java compiler doesn't care what you write in there, it only serves as documentation for others to understand the purpose of that class in the context of your application. Write a description that conveys that information.
can you give another simple example like without using class book
Post by:Stephan van Hulst
, Saloon Keeper
(1 like)
If you look at the Java Standard API documentation, you have look at descriptions for various classes. That might give you some inspiration.
Post by:Tim Cooke
, Marshal
Great advice from Stephan.
Post by:autobot
When it is used for evil, then watch out! When it is used for good, then things are much nicer. Like this tiny ad:
![[Logo]](/templates/default/mobile/images/mobile-moose.gif)
