Name: krT82822 Date: 01/25/2000


java version "1.3beta"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.3beta-O)
Java(TM) HotSpot Client VM (build 1.3beta-O, mixed mode)

Allow a shortcut like #foo# or @foo@ or {@ foo} or some such for
<code>foo</code>.

Motivation: I am being very conscientious about doc commenting this project and
already the doc comments have come in handy for both review purposes and
because it forces one into the mindset of writing clean code and especially
clean interfaces -- and this before even a preliminary run of javadoc! (We are
having problems with GNU Make, it seems to be having trouble with dependencies
and targets being specified by macros -- but that's another story). However,
writing <code> and </code> tags is actually amounting to noteworthy time.

(Incidentally, does {@link foo bar} with foo an API element as opposed to a URL
automatically turn on <code> for the link text?)

----------------------

I'm suggesting a javadoc tag that turns on <code> in the generated HTML for
a certain segment of the document, and is less unwieldy than writing <code>
(6 symbols) and </code> (7 symbols) repeatedly. Say, @@word for a single
word, {@code phrase} for a phrase with whitespace.
(two symbols in the first case, eight in the next, versus 13 the traditional
way.)

(Review ID: 99804)
======================================================================