Win a copy of The Little Book of Impediments (e-book only) this week in the Agile and Other Processes forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Formatting of the SUN's Interface

 
Olena Golub
Ranch Hand
Posts: 113
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Everyone,
I know my question is a little bit silly, but I would like to ask you about it
Do I need to format the SUN's Interface? I don�t mean the change of the method�s sequence or changing the methods signatures.
I mean the change of the comments structure, something like this:

reformatting correspond to javadoc, something like this:


Could you share your experience? Have you formatted Sun�s Interface or not?
Thanks a lot for your support!
Regards,
Olena
 
Frans Janssen
Ranch Hand
Posts: 357
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Olena,

I reformatted the interface and added the javadoc comments, as in your example. I don't think I have been penalized for that.

Frans.
 
Wei-ju Wu
Ranch Hand
Posts: 147
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Olena,

I changed the docs and the formatting too, to be consistent with the JavaDoc and even did another change (an obvious one, but more dangerous) and documented both. I'll have yet to see the result of that though.

Wei-ju
 
Paul Bourdeaux
Ranch Hand
Posts: 783
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I also changed the formatting of the interface so that the comments were correct. I was not penalized at all for it.

I wouldn't make changes that affect the interface itself though... Sun is pretty specific about NOT changing the interface contract at all, so any other changes may be pretty dangerous.
 
Wei-ju Wu
Ranch Hand
Posts: 147
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I neither changed semantics nor the signature - I removed the "public" modifiers (after compiling the two class files are exactly the same)
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic