Bases de dados de projectos: Construa a sua própria documentação para componentes

Num post de blog anterior, mostrámos-lhe que a documentação para os métodos voltou no Explorer. Quer levar as coisas ainda mais longe e utilizá-las como documentação para os seus componentes? Neste post do blogue, mostrar-lhe-emos como!

Partilhar código fonte e documentação

A partilha de fontes componentes com bases de dados de projectos é muito fácil(por exemplo, através do GitHub). Para explicar como utilizá-las, a documentação é essencial. A documentação no Explorador é guardada em ficheiros Markdown, para que possa utilizá-la para criar documentação para os seus componentes.

Se utilizar GitHub, pode criar um mini-site para a sua documentação. Basta criar um ficheiro README com um link para a documentação de cada método. Depois, nas definições do seu repositório, active a página do GitHub.

Voilà!

Componente Compilado E DOCUMENTAÇÃO

Ao construir o seu componente ou aplicação compilada com o diálogo “Construir Aplicação”, a pasta “Documentação” é automaticamente copiada para a pasta final do projecto.

Quando um programador integra o seu componente na sua base de dados, pode ver directamente a documentação no Explorador em 4D.