commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "simon.kitching@chello.at" <simon.kitch...@chello.at>
Subject Re: [lang] Java 5
Date Thu, 12 Jun 2008 12:20:13 GMT
Emmanuel Bourg schrieb:
> sebb a écrit :
>
>> BTW, perhaps Commons should have a similar naming convention for
>> packages that need to contain public methods, but which are only
>> intended to be used in Commons libraries.
>
> Or a big "DO NOT USE THIS CLASS, RESERVED FOR INTERNAL USE" in the
> Javadoc ?
In the MyFaces project, the convention is to use a leading underscore on
the names of classes that are not intended to be part of the stable
public API (but cannot be package-scoped for technical reasons), eg
  public class _WidgetUtils {....}

A javadoc comment like the above is also attached, but the leading
underscore makes these classes really stand out.

Regards,
Simon


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Mime
View raw message