Message:
The following issue has been closed.
Resolver: Aslak Helles�y
Date: Thu, 19 Dec 2002 3:37 PM
It would require too much work in the grammar, and I don't see a real benefit.
And what if the comments were intentional? Lots of warnings?
We can't baby-sit programmers who haven't taken the time to learn the Java syntax.
They're not ready for XDoclet anyway.
---------------------------------------------------------------------
View the issue:
http://opensource.atlassian.com/projects/xdoclet/secure/ViewIssue.jspa?key=XJD-11
Here is an overview of the issue:
---------------------------------------------------------------------
Key: XJD-11
Summary: Warn of common mistakes in javadoc comments
Type: New Feature
Status: Closed
Priority: Minor
Resolution: WON'T FIX
Time Spent: Unknown
Estimate: 0 minutes
Project: XJavaDoc
Component: None
Assignee: xdoclet-devel (Use for new issues)
Reporter: Andrew Stevens
Created: Wed, 18 Dec 2002 9:25 AM
Updated: Thu, 19 Dec 2002 3:37 PM
Description:
Presumably, the parser/grammer must be checking for and distinguishing between
ordinary (/* ...) comments as well as javadoc (/** ...) ones, otherwise people
wouldn't be having problems with XDoclet not seeing the tags they've specified when
they use the wrong opening delimiter.
Would it therefore be possible, while parsing the class, to check for this and print a
warning? i.e. If there's no javadoc comment in a place we might expect one
(immediately prior to a method/field/class declaration), but there is an ordinary
comment (possibly also checking that this comment contains a @tag), then print a
warning to the console about the possible ambiguity/error.
Similarly, if it encounters a javadoc comment in one of the "usual" incorrect places
(e.g. before the package or import statements instead of before the class declaration)
then print a warning that this isn't a valid place for a javadoc comment and it's only
going to be treated as a normal comment?
Then we might get less bug reports and problems on the mailing lists that are due to
people's dodgy javadoc comments...
---------------------------------------------------------------------
JIRA INFORMATION:
This message is automatically generated by JIRA.
If you think it was sent incorrectly contact one of the administrators:
http://opensource.atlassian.com/projects/xdoclet/Administrators.jspa
If you want more information on JIRA, or have a bug to report see:
http://www.atlassian.com/software/jira
-------------------------------------------------------
This SF.NET email is sponsored by: Geek Gift Procrastinating?
Get the perfect geek gift now! Before the Holidays pass you by.
T H I N K G E E K . C O M http://www.thinkgeek.com/sf/
_______________________________________________
Xdoclet-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
