|
Description
|
It _might_ be of interest to have an '@tag' tag. The syntax would be:
@tag <tag_name> comment
Then, javadoc could be told to search for all @tags with 'tag_name', and
list those classes/methods/variables. This would allow quick and dirty
tagging for during development. Admittedly this could be done with
doclets, however, this way it should be a fairly minimal amount of work
to implement, with major and immediate benefit for many.
Obviously, many things wouldn't be checked, such as the correct spelling of
'tag_name', but even that could be added by having one option for
javadoc specifying a list of all allowed 'tag_name's.
The thing that made me think of this, was when I was going through the
Swing classes, and saw lots of places where they were talking about
how such-and-such would be moved elsewhere, or done differently, in
the next version, but these things did not seem to have been done yet -
so I thought of a '@in_development' or '@todo' type tag, but that is, again,
really specific, and not at all useful for post-development support. So, the
'@tag' occurred to me as an ideal way to easily facilitate developers to
add these 'temporary' tags.
Benjamin PFLANZ < xxxxx@xxxxx -livre.fr>
|
|
Evaluation
|
I believe this is a dupe of another RFE. Someday we should cross-reference
them.
xxxxx@xxxxx 1998-08-28
I found the near-dupe: 4039014: Tag listener - Flag misspelled tags while printing custom tags. Jamie, feel free to combine these. This is highly
requested.
xxxxx@xxxxx 2001-03-01
Actually, this is an alternative solution to:
4282805 stddoclet API: Add tag listener interface for custom tags
xxxxx@xxxxx 2001-06-15
Jamie implemented this as 4282805 "Add tag listener interface for custom tags"
Closing out as a dupe.
xxxxx@xxxxx 2001-06-29
|