Improving ddoc

via Digitalmars-d digitalmars-d at puremagic.com
Fri Jan 2 02:11:21 PST 2015


On Thursday, 1 January 2015 at 22:38:05 UTC, Jacob Carlborg wrote:
> That are just a couple of suggestions. Just take a look at some 
> existing documentation for other language and see what's 
> missing [1], [2].
>
> [1] 
> http://help.eclipse.org/luna/index.jsp?topic=%2Forg.eclipse.jdt.doc.isv%2Freference%2Fapi%2Foverview-summary.html
>
> [2] 
> http://www.scala-lang.org/api/current/#scala.collection.Iterable

To me Ddoc documentation is different from javadoc-flavored 
documentation and rightfully so. Ddoc is module centered with 
some nice introduction at the top and includes helpful unittest 
examples, too. Where OO-centered reference documentation puts 
comments to all classes and methods, Ddoc allows (and encourages) 
documentation that can be read to learn about the module. You 
know, I am your average troll, spending my time reading 
documentation. Pure reference documents are no fun to read.


More information about the Digitalmars-d mailing list