Yes, we agree :)

And it would be wonderful, if IDEA helped us more to create those JavaDocs
and to keep them up-to-date...


Johannes Schneider

-----Urspr�ngliche Nachricht-----
Von: Mike Aizatsky [mailto:[EMAIL PROTECTED]] 
Gesendet: Mittwoch, 20. Februar 2002 12:30
An: [EMAIL PROTECTED]
Betreff: [Eap-list] Marking JavaDoc errors

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

Reply via email to