CLI

dataforge doc

Gerar documentação Markdown

Uso#

bash

dataforge doc lib.df                    # imprime no terminal
dataforge doc src/ --out=doc/API.md

O comentário imediatamente acima de uma declaração é a sua documentação. Os comentários do topo do arquivo viram a descrição do módulo.

dataforge

// Calcula a area de um circulo.
// O raio precisa ser positivo.
action area_circulo(raio: Number) -> Float:
    yield PI * raio ** 2