• Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Bear Bibeault
  • Ron McLeod
  • Jeanne Boyarsky
  • Paul Clapham
Sheriffs:
  • Tim Cooke
  • Liutauras Vilda
  • Junilu Lacar
Saloon Keepers:
  • Tim Moores
  • Stephan van Hulst
  • Tim Holloway
  • fred rosenberger
  • salvin francis
Bartenders:
  • Piet Souris
  • Frits Walraven
  • Carey Brown

Least Necessary To Document Class

 
Ranch Hand
Posts: 95
Spring Flex Java
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Can any one tell me please that which one is LEAST necessary to document for class.
a) work flow
b) description
c) superclass
d) operations
e) attibutes
Select any ONE correct answer.
I think the answer is (a)work flow.
 
Ranch Hand
Posts: 116
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I would say (e), 'cos usually they are self descriptive, and also more likely they are private.
Rama
 
Sheriff
Posts: 6920
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
What a strange question!
The only ones that stand out as things that might need to be documented are work flow and description. Surely superclass, attributes and operations (methods) are right there in the code for all to see!
Can you give us any background to this question?
 
Ranch Hand
Posts: 765
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,
Considering Java API documentaion, we see that SUN has documented
1: attributes
2: methods
3: supercalss
There is a tie between work-flow and description. These both things are covered in-depth in specification. I think both are less important to document. But if i have a constraint to choose exactly one, then i'll go for work-flow because atleast little bit descrption about class is there in documentaion. We can see that SUN has given example of using classes were neccessary, which is a part of description rather then work-flow.
Bye,
Viki.
 
author
Posts: 14112
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator

Originally posted by Vikrama Sanjeeva:
Hi,
Considering Java API documentaion, we see that SUN has documented
1: attributes
2: methods
3: supercalss


But that's API documentation for users outside of the original development team. Inside a team (especially a smaller one) you will need much less documentation.
Additionally, I don't think that the Sun code always is as well designed as it should be. It's no wonder that a complex monster like GridBagLayout needs much external documentation... :roll:
 
Ranch Hand
Posts: 90
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
If the documentation refers to generation of javadoc then i think the 'operation' option may be correct.
a class may exist without any attributes, but it will always have one operation which is the default constructor.
the javadoc for the class will show the default constructor as one of the 'operations'
 
Vikrama Sanjeeva
Ranch Hand
Posts: 765
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,

Originally posted by Ilja Preuss:

But that's API documentation for users outside of the original development team. Inside a team (especially a smaller one) you will need much less documentation.


Then about which documentation of class Arain is talikung about? Is it the documentation which is written for users outside the origibal team? or it is written for using within team?

Originally posted by Ilja Preuss:
Additionally, I don't think that the Sun code always is as well designed as it should be. It's no wonder that a complex monster like GridBagLayout needs much external documentation... :roll:


This is obvious in software engineering that no one can claim that his/her design is 100% correct! Secondly, I gave the example of SUN because I think the guys are atleast experience then us. Well, no language is 100% in it's first version. Why assertions are included in jdk1.4? why not in jdk1.1? These things are obvious. Reason behind these questions have some good strategy of business and some lack of experince.
Bye,
Viki.
 
Ilja Preuss
author
Posts: 14112
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator

Originally posted by Vikrama Sanjeeva:
This is obvious in software engineering that no one can claim that his/her design is 100% correct!


I wasn't talking about "not 100% correct" design, I was talking about *horrible* design. But this starts to get off topic - we should start another thread if wanted to explore this in more detail...
 
Iftikhar Arain
Ranch Hand
Posts: 95
Spring Flex Java
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Can any one tell me please that which one is LEAST necessary to document for class.
a) work flow
b) description
c) superclass
d) operations
e) attibutes
Dears I am talking about to document the class in RUP or in iterative development in the designing of the system.
In RUP Craig larman and fowler both has document the following for class
a) operations or methods
b) attributes
c) superclasses as specialization and generalization
d) description
In some cases the clsses have a typical workflow so they also document the description of the class for that typical workflow.
And then for detailed workflow they have uses the state diagrams.
So I think least necessary for document the class is Workflow.
Plz correct me if I am wrong.
Thanks.
 
Vikrama Sanjeeva
Ranch Hand
Posts: 765
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,

Originally posted by Ilja Preuss:
we should start another thread if wanted to explore this in more detail...


I'll love to discuss if u starts one
Bye,
Viki.
 
Destiny's powerful hand has made the bed of my future. And this tiny ad:
Thread Boost feature
https://coderanch.com/t/674455/Thread-Boost-feature
    Bookmark Topic Watch Topic
  • New Topic