proposal: heredoc comments to allow `+/` in comments, eg from urls or documented unittests

Dominikus Dittes Scherkl dominikus.scherkl at continental-corporation.com
Fri Feb 9 15:26:30 UTC 2018


On Friday, 9 February 2018 at 11:16:01 UTC, Nick Sabalausky 
(Abscissa) wrote:
>
> /**
> Be sure to check the various files at extras/foo*/package.d
> and also: https://gcc.gnu.org/onlinedocs/libstdc++/faq.html
> */
>
> Unlike the "disabling code that contains the 
> end-of-disabled-code token" stuff, THIS example isn't quite so 
> trivial to deal with in a way that's reasonably readable from 
> both the generated docs and from within the code itself.

How about

// Be sure to check the various files at extras/foo*/package.d
// and also: https://gcc.gnu.org/onlinedocs/libstdc++/faq.html

The good part of having multiple comment starters is that you can
pick the one that works best with a specific text you would
like to add as a comment.
// goes to the end of the line, so the text can be pretty much 
anything
(except for EOL of course), so is a good fallback.


More information about the Digitalmars-d mailing list