Documenting Standards

Documenting Standards

This document describes the guidelines and specifications for documenting C4 code base. Anything that doesn't follow these guidelines will be rejected. Please read this carefully before contributing.

Documenting style

The basic rule is "follow the current style". We want the documentation to follow the same formatting style throughout. In particular:

D1

Use the triple-slash markers /// to mark documentation, rather than the block quote asterisk /** */.

D2

Code blocks should be wrapped with 4 ticks (above and below):

///````
///func example() {
///}
///````