+1
although, I am usually pretty consistent at writing javadoc, when writing
new methods I allways forget to update it, when I make api-changes. And as
everyone knows noone is going to fix it later on (unless he is forced to do
it). I love it that I can't distinguish a javadoc-error mark from other
errors, 'cause this way I can't say "nay, I don't look at this, it's just
JavaDoc". And once I'm there its usually a no-brainer to fix the broken
tag. Please keep it this way (or make it an option, 'cause "every feature
that can't be turned off is a bug").
regards
Joachim Sauer
"Mike Aizatsky"
<[EMAIL PROTECTED] An: <[EMAIL PROTECTED]>
m> Kopie:
Gesendet von: Thema: [Eap-list] Marking JavaDoc errors
eap-list-admin@in
tellij.com
20.02.2002 12:29
Bitte antworten
an eap-list
Hi, All
There are several requests to change JavaDoc errors marking to be not
red. I'd like to argument our decision and to hear your opinion.
The most common critique of current highlighting is the fact that
compiler will compile the file without errors. But JavaDoc _will_
produce errors (well, at least it should :). And if there are some
errors in JavaDoc, chances are quite high that JavaDoc is outdated. And
is outdated JavaDoc better than not having it at all? I think not much
better. Just look through some Sun's classes. There's plenty of JavaDoc
errors. And we, developers, should read it and try to figure out what
should be instead of the error text.
So, the question is: are JavaDoc errors serious ones? The answer seems
to be "yes". If you have documentation, you must keep it consistent or
throw away.
Do you agree?
Best regards,
Mike Aizatsky.
------------------------------
IntelliJ Software, "Develop with pleasure!" http://www.intellij.com
_______________________________________________
Eap-list mailing list
[EMAIL PROTECTED]
http://www.intellij.com/mailman/listinfo/eap-list
_______________________________________________
Eap-list mailing list
[EMAIL PROTECTED]
http://www.intellij.com/mailman/listinfo/eap-list
