Win a copy of The Business Blockchain this week in the Cloud forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

NX Contractor - Sun interface no javadoc comments?

 
BillLeighton
Greenhorn
Posts: 20
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Should we add javadoc comments to the Sun-supplied interface, or is this considered untouchable?
 
Jim Yingst
Wanderer
Sheriff
Posts: 18671
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I consider it untouchable. "...must implement the following interface" is enought for me; I'm keeping the exact interface they gave, warts and all. My own implementation does of course have proper javadoc...
 
Matthew Blaise
Greenhorn
Posts: 10
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I'm sure you can do whatever you like to the interface file as far as commenting/layout is concerned. The important thing is that the actual code should not change at all. I really don't think the compiler cares about javadoc, comments, whitespace, or order of function declaration. So go crazy. Just make sure that you can swap the original in place of your edited one with no problems.
Blaise
 
Matthew Blaise
Greenhorn
Posts: 10
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
...to answer your question more specifically:
1. SHOULD we add javadoc comments to the interface file?
No. I doubt you will be penalized if you leave the file as-is.
2. Is this an "untouchable file"?
No. I'm sure you can do anything I mentioned in the previous reply without any problems.
 
Billy Tsai
Ranch Hand
Posts: 1304
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
well I have added comments to the methods that didnt have any comments when I got the interface file in javadoc style, also used correct spacing and line positions etc....
also specified author, date,version.
I dont think its untouchable, just dont change what came with it.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic