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.
Perform the following steps to document your code:
Attach documentation comments to declarations by writing
/** Docs */or/++ Docs +/above them or/// short descriptiondirectly after them.Put documentation comments on both collections and members. For example, if you document a class member, ensure that there's a
doccomment on the class itself too.Document unit tests that you want to serve as usage examples.
Document function parameters by writing lines in the format:
name = meaningunder a sectionParams:.Compile the module with the
–Dflag todmdto generate the documentation's HTML file.You may define and use macros. They are defined in a special section named
Macros:with aname=valuesyntax and used with$(name...