This week's book giveaway is in the Kotlin forum.
We're giving away four copies of Kotlin in Action and have Dmitry Jemerov & Svetlana Isakova on-line!
See this thread for details.
Win a copy of Kotlin in Action this week in the Kotlin forum!
  • Post Reply Bookmark Topic Watch Topic
  • New Topic

Class Desciption  RSS feed

 
Manaf Abdul
Greenhorn
Posts: 20
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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.
 
Tim Cooke
Marshal
Posts: 3872
233
Clojure IntelliJ IDE Java
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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.
 
Dave Tolls
Rancher
Posts: 2914
36
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
All that needs is a description of what the Book class represents and what it does.
 
Manaf Abdul
Greenhorn
Posts: 20
  • Likes 1
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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 ??
 
Tim Cooke
Marshal
Posts: 3872
233
Clojure IntelliJ IDE Java
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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.
 
Manaf Abdul
Greenhorn
Posts: 20
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
 
Stephan van Hulst
Saloon Keeper
Posts: 7817
142
  • Likes 1
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
If you look at the Java Standard API documentation, you have look at descriptions for various classes. That might give you some inspiration.
 
Tim Cooke
Marshal
Posts: 3872
233
Clojure IntelliJ IDE Java
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Great advice from Stephan.
 
It is sorta covered in the JavaRanch Style Guide.
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!