Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
[jakarta.ee-spec.committee] convention for class names in specs?

What's our preferred convention for use of class names in spec documents?

Should class names (and other Java programming language elements) appear
in a fixed width font in the document?

Or should they use the same font as the surrounding text?

(This is ignoring blocks of code, which I believe should always be in a
fixed width font.)

The "pro" is that using a fixed width font makes it clear that this is
a Java class name being referred to.

The "con" is that it clutters up the text making it harder to read with
lots of font changes.

Comments?


Back to the top