Documenting your code with Ddoc

To verify your code is working correctly, you must know what it is supposed to do. Like with unit testing, D has a built-in documentation generator called Ddoc. Ddoc is fairly simple, but it gets the job done and is always available.

How to do it…

Perform the following steps to document your code:

1. Attach documentation comments to declarations by writing /** Docs */ or /++ Docs +/ above them or /// short description directly after them.

2. Put documentation comments on both collections and members. For example, if you document a class member, ensure that there's a doc comment on the class itself too.

3. Document unit tests that you want to serve as usage examples.

4. Document function parameters by writing lines in the format: name = meaning under a section Params:.

5. Compile the module with the –D flag to dmd to generate the documentation's HTML file.

6. You may define and use macros. They are defined in a special section named Macros: with a name=value syntax and used with $(name...