Re: Can I have comment lines in Java property file?
Lew:
One wonders why you choose to reference docs for an obsolete version,
then tell people to refer to the current version.
Stanimir Stamenkov wrote:
I refer to older docs to emphasize the stuff is available at least
starting with that obsolete version.
At my previous workplace, an year ago I was still maintaining (only
critical and small fixes) a Java 1.3 application. The recent
application version six months ago was officially using Java 1.4. While
it may already run using JRE 1.5 I know no Java 5 features and APIs have
been employed in that application, yet.
I also maintain Java 1.3 and Java 5 code, at my current workplace today, no
less. But the modern Javadocs tell you when methods came into existence.
'Properties.html#load(java.io.InputStream)' is clearly marked, "Since: 1.2",
<http://java.sun.com/javase/6/docs/api/java/util/Properties.html#load(java.io.InputStream)>
and 'Properties.html#load(java.io.Reader)' is clearly marked, "Since: 1.6".
<http://java.sun.com/javase/6/docs/api/java/util/Properties.html#load(java.io.Reader)>
At least by not being a stick-in-the-mud about old docs, and giving the
*current* relevant information, one gives the querent the knowledge that "the
stuff is available at least starting with that obsolete version" without
depriving them of the knowledge that, should they actually not be using an
obsolete Java version themselves, they have a superior method available. In
this case it was not appropriate to assume that in looking at "more recent
Java versions for changes, ... there shouldn't be any." Indeed, there was a
significant change with the addition of a much more useful method.
--
Lew