<i18n dev> RFR: 8300706: Use @snippet in java.text [v2]

Naoto Sato naoto at openjdk.org
Fri Jan 20 19:00:31 UTC 2023


On Fri, 20 Jan 2023 18:34:37 GMT, Lance Andersen <lancea at openjdk.org> wrote:

>> src/java.base/share/classes/java/text/DecimalFormat.java line 343:
>> 
>>> 341:  * <blockquote><pre><strong>{@code
>>> 342:  * // Print out a number using the localized number, integer, currency,
>>> 343:  * // and percent format for each locale}</strong>{@code
>> 
>> This comment is originally in strong font within the code example. Replacing both instances of `@ code` with `@ snippet` will just create two separate snippet blocks, one for the comment and one for the code which does not seem ideal.
>> 
>> To maintain the strong font, the comment has to be outside of the code snippet.
>> 
>> If that's not desirable, I think some alternatives are
>> 
>> - Leave the comment in the code snippet and get rid of the strong font 
>> - Keep the strong font but convert the comment into a normal text description
>
> I would leave the comment in the code snippet.  I don't see a compelling reason for it to be  as it was originally

+1

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

PR: https://git.openjdk.org/jdk/pull/12121


More information about the i18n-dev mailing list