[Issue 14413] Spurious newline in ddoc JSON output for multiple successive line doc comments

via Digitalmars-d-bugs digitalmars-d-bugs at puremagic.com
Thu Feb 9 00:37:53 PST 2017


https://issues.dlang.org/show_bug.cgi?id=14413

Walter Bright <bugzilla at digitalmars.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |RESOLVED
                 CC|                            |bugzilla at digitalmars.com
         Resolution|---                         |WONTFIX

--- Comment #9 from Walter Bright <bugzilla at digitalmars.com> ---
/// This function is here to aid in making your
/// software do cool stuff.

is treated exactly the same way as:

/** This function is here to aid in making your */
/** software do cool stuff. */

I.e. all three comment styles are treated the same way, as Martin suggested.

I am very reluctant to change this because:

1. things would be no longer consistent

2. Ddoc has been in use for a very long time, and this could break an unknown
large amount of existing code in a rather annoying fashion

3. There's an easy solution - use the multiline comment style for multiline
comments, i.e.

/**
 * This function is here to aid in making your
 * software do cool stuff.
 */

I.e. the breakage risk is high for a relatively small benefit.
That's how it was designed to work.

--


More information about the Digitalmars-d-bugs mailing list