Improving ddoc

via Digitalmars-d digitalmars-d at puremagic.com
Thu Jan 1 12:38:05 PST 2015


On Thursday, 1 January 2015 at 19:57:56 UTC, Walter Bright wrote:
> On 1/1/2015 8:39 AM, Manu via Digitalmars-d wrote:
>> It's just noisy and hard to read, as
>> I think we've established to be the popular opinion.
>
> Is also hard to read. Yes, I'm being facetious, but take a look 
> at those examples posted here about how ugly Ddoc is - they're 
> of that category.

At this point it might be helpful to point out that Ddoc does its 
jobs very well. It deserves praise on its merits. For properly 
documented code, however, it requires more visual noise than 
desirable. Take std/algorithm.d as an example.

In my opinion replacing $(D ...) with `...` boosts the file 
considerably.

The beauty of markdown is that it requires significantly less 
visual noise. It is not clean what markdown actually is, so 
voting for it might be nonsensical. On the other hand, I believe 
in reading source code and some documentation in phobos is 
unreadable to me. This is why I think Ddoc should be improved.


More information about the Digitalmars-d mailing list