Raw String Literals for JavaDoc
Jonathan Gibbons
jonathan.gibbons at oracle.com
Fri Jan 18 22:37:09 UTC 2019
Nir,
There are some fundamental reasons why it is not possible to all of what
you suggest in the way you suggest (i.e. using raw string literals) For
the most obvious example, albeit a bit of an obscure case, would be a
raw string literal containing a /*...*/ comment. Similar problems apply
to the appearance of `@` which already has an existing meaning in
documentation comments.
That being said, we are already investigating better ways to include
code samples and snippets in documentation comments, perhaps by being
able to insert code from a "nearby" source file, which would have the
advantage that (separately) the source file could itself be compiled to
ensure that it is syntactically correct.
-- Jon
On 01/18/2019 02:08 PM, Nir Lisker wrote:
> Hi,
>
> I sent am email to amber-dev about the possibility of using Raw String
> Literals in JavaDoc [1]. I was sent here and told there was some
> discussion in this area. Would what I describe in [1] be possible in
> some form?
>
> Thanks,
> Nir
>
> [1]
> https://mail.openjdk.java.net/pipermail/amber-dev/2019-January/003906.html
More information about the javadoc-dev
mailing list