• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

JavaDoc & Sun's interface DB

 
Lucy Hummel
Ranch Hand
Posts: 232
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,

You know Sun provides an interface that has to be implemented.

The interface is commented by Sun. Sun uses comments like


So the comments are NOT add to JavaDoc.

I ask myself now, if I can change the DB interface so that the comments are add by JavaDoc, like


I am afraid that I do not pass the exam because I changed what Sun has provided me.

What is your opinion on that? What did you do? What are you going to do on that issue?

Looking forward to your opinions and suggestions.

Br, Lucy
 
chris bajada
Ranch Hand
Posts: 41
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Honestly i do not know what's right or wrong in that aspect. My opinion is that since they provided the interface, it should have javadoc as they have provided it.

In fact I even provided the same javadoc for the data.java, as it is explained very well in sun's comments... so why worry.

In the rules they state that the code must be entirely our own ... in our case we would be copying comments and not code

hope we get over with this neverending project soon
 
Arno Reper
Ranch Hand
Posts: 286
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hello,
I modify it...I didn't change the code, only the comments...

Arno
 
Petr Hejl
Ranch Hand
Posts: 68
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I modify the comment to be the javadoc comment. No problem with it. If you are really afraid write the reason to choices.txt.

I succeeded.
 
Mark Smyth
Ranch Hand
Posts: 288
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I changed the comments to javadoc also and I passed, there is no possibility that you will be failed for doing this as they are not really a part of the interface anyway.
 
David A. Scott
Ranch Hand
Posts: 55
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
For what it's worth - I've done the same. i.e. changed all their comments to JAVADOC (and added @param tags etc)

You are still implementing the interface regardless of whether the comments have changed and if you don't do it there'll be a gap in your generated javadocs.
 
Lucy Hummel
Ranch Hand
Posts: 232
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,

Now I have added Sun's comments and some additional @param @throw declarations to the JavaDoc.

Further, I add to the assumption list the entry, why I changed and updated the comments that were given by Sun.

Let see what Sun thinks about it.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic