RFR: 8276124: Provide snippet support for properties files [v4]
Pavel Rappo
prappo at openjdk.java.net
Tue Nov 23 21:41:09 UTC 2021
On Tue, 23 Nov 2021 17:11:38 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:
> > > It would be nice to define/support the markup characteristics of "plain text" snippets, where "plain text" might be a stand-in for commands, or stack traces, or other less common formats.
> >
> >
> > If we are to do it, we should discuss and implement it quickly, before RDP 1. We would still be able to do it later, before RC, but only with approval. Here are some questions to discuss.
> >
> > 1. What `lang` identifier(s) should plain text use?
> > 2. What comment rules and markup marker(s) should plain text use?
>
> 1. Either "text" or _none_
> 2. Right now, it defaults to `//` which is OK, but `#` might be better.
>
> Maybe too late for now, allow a new attribute to specify the markup "prefix" (`//`, `#`, `!`, etc)
Introducing such an attribute just for plain text seems ad-hoc. This is because there are dependencies between these three elements that make them not completely orthogonal:
1. Comment marker (i.e. `#`, `--`, `//`, `!`, etc.)
2. Comment type (i.e. whether it's an EOL comment or a comment line)
3. `lang` or type of external file (e.g. file extension)
-------------
PR: https://git.openjdk.java.net/jdk/pull/6397
More information about the javadoc-dev
mailing list