Comments on: How to warn users not to use an interface

By: Mathieu Berube

Mathieu Berube — Sat, 24 Jul 2010 03:28:17 +0000

@jfproulx Hope it wasn’t too painful

@Eric Have you ever used a similar approach in your own code? Just wondering how people reacted

By: Eric Le Merdy

Eric Le Merdy — Fri, 23 Jul 2010 15:57:42 +0000

Yes, I was stunned by this method. It really matches my programming style : you know, nobody want to read the f***king manual especially developers.
You want to get a lib in your classpath and start using it directly ! APIs are so well written this days. If you are addicted to CTRL+Space to get completion, a method like that is really what you expect to truly helping you. Moreover, the first ‘_’ character makes it appearing on top of all methods in the completion pop-up.

@Abderrazak:
If that _practice_ is rejected by the Sonar _tool_, it just does not matter if it makes sense for _people_. Do you remember the first principle of the agile manifesto ?

By: jfproulx

jfproulx — Fri, 23 Jul 2010 13:19:34 +0000

I almost had a cardiac arrest when I read your title. Why wouldn’t you want your users to use interfaces, that’s what interfaces are for… Then I understood that we don’t have the same meaning for user nor for interface!

Keep on ducking, my heart has restarted!

By: Mathieu Berube

Mathieu Berube — Fri, 23 Jul 2010 12:20:30 +0000

What do you mean about ‘developer mail box will be spammed’? Because there will be an warning in Sonar?

If I remember correctly you can always tell Sonar to ignore warnings coming from a class.

You’re right that there might be issues with some tools – but then there might be issues because users of your API implement an interface that might change in the future.

By: Abderrazak

Abderrazak — Fri, 23 Jul 2010 08:03:58 +0000

There will be some troubles doing so, for example sonar will have trauma and developer mail box will be spammed