• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

DBAccess javadoc + redundant public modifier

 
Sebastian Puzon
Greenhorn
Posts: 13
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi All!

I just started play with my Urlybird 1.2.1 and I would like to share with you my thoughts about making changes in provided by sun interface.

First thing after setup project in eclipse I wanted to do was to ensure that all code will adhere to JLS and javadoc style. As You know original DBAccess is not as pretty as we would like to.

At first I decided to refactor comments to apply with javadoc style.

Then I noticed style warning regarding redundant public modifier in this interface. According to JLS it's strongly discouraged. And question appeard, should I change it? will this brake interface or automatic test?

I saw this post. The biggest concern was about failing automatic tests or braking interface, so i decided to check binary file original vs modified and looks like they are the same. If I try to modify a bit methods in interface it'll be broken - of course

Sun mentions also that my decisions have to be consistent, so i think that changing comments and removing redundant modifier is.

Hope that will help someone solve similar concerns.
[ September 04, 2008: Message edited by: Sebastian ]
 
Jethro Borsje
Ranch Hand
Posts: 100
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I decided to fix the comments so they are in JavaDoc format, however I decided to not remove the public declaration.
 
Ernesto Elias-Nieland
Ranch Hand
Posts: 53
Eclipse IDE Spring Tomcat Server
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I removed the redundant modifier. I think it is both acceptable as long as you document your decision.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic