• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

direction from senior developers

 
reena kadam
Greenhorn
Posts: 16
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hello everybody,
I have following queries.
Requesting for help.
1. When creating javadoc, I get 70 warnings saying @serial tag missing... !!! ? Is it ok ? or i have to implement serializable in FbnRemoteData and other class ??
2. My client programm starts with FbnClient... and then FbnClient starts Mode class (for selecting mode) and then FbnUI (user Interface).
My problem is what should i write in explanation and in javadoc comments. Should I write
" FbnClient initialises mode class and once mode is selected FbnUI class is initiated."
OR should i write
" FbnClient intantiates mode class and then FbnClient intantiates FbnUI..."
OR "FbnClient creates instance of mode class and once mode is selected, instance of FbnUI is created..."
my mode class (one method) returns DataClient object.
i.e. in mode class , either Data class object is created or "FbnRemote" class object is created....
Exactly I am not theoratically sure whether it is refernce that is returned (by method) or it is the object as a whole that is passed. ?
If i am not wrong, Data class 'object' will pass (in local mode ) while FbnRemoteData refernce will pass(network mode) is this right ? if so could i write in javadoc that..
" in local mode, Data Object will be returned and if remote mode is selected, reference of the FbnRemote object will be returned by the ...method. "
kindly help
regards
Reena k.
 
reena kadam
Greenhorn
Posts: 16
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I am waiting for some guideline.
pl. help.
Any comment would be appreciated.
Reena K
 
reena kadam
Greenhorn
Posts: 16
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
What is problem with my query ?
No reply ?
No body is giving ans ??
pl. give your view on my doubts
 
Mark Spritzler
ranger
Sheriff
Posts: 17278
6
IntelliJ IDE Mac Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Sorry Reena, I just don't know. I have never heard of the @serial
tag for javadoc, it's not in any of my classes. Maybe it is with some arguments that you passed in the dos prompt for javadoc?
And how you write your javadoc stuff, is really just your own preferences. Can't really say which of the two version you have that I like over the other. They both sound fine to me, as long as it explains the method and code.
Mark
 
kerry shih
Greenhorn
Posts: 15
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I found a good way to learn how to comment is by looking at Sun's jdk code. If you have the source or find it on the net. Their code is a pretty good example of elaborate documentation.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic