Writing Documentation

The way it works is very similar to Go. It's very simple: there's no need to write documentation separately for your code, vdoc will generate it from docstrings in the source code.

Documentation for each function/type/const must be placed right before the declaration:

// clearall clears all bits in the array fn clearall() { }

The comment must start with the name of the definition.

Sometimes one line isn't enough to explain what a function does, in that case comments should span to the documented function using single line comments:

// copy_all recursively copies all elements of the array by their value, // if `dupes` is false all duplicate values are eliminated in the process. fn copy_all(dupes bool) { // ... }

By convention it is preferred that comments are written in present tense.

An overview of the module must be placed in the first comment right after the module's name.

To generate documentation use vdoc, for example v doc net.http.

Newlines in Documentation Comments

Comments spanning multiple lines are merged together using spaces, unless

  • the line is empty
  • the line is purely of at least 3 of -, =, _, *, ~ (horizontal rule)
  • the line starts with at least one # followed by a space (header)
  • the line starts and ends with a | (table)
  • the line starts with - (list)
On this page