Documentação do Módulo

Esta página contém um template para a documentação das capacidades disponíveis para o Módulo, na forma de uma lista organizada de classes, constantes, instâncias, comandos, etc. Em geral, sugere-se que os itens sejam documentados individualmente, cada um em sua página, que deve conter uma breve explicação do comando (usando a linguagem matemática, se necessário — lembre-se que este wiki aceita sintaxe Latex), suas opções, e no mínimo um exemplo adequado de utilização.

A documentação é em geral mais crua que um tutorial. Seu objetivo é servir de referência à API do Módulo, e dar um exemplo prático de utilização. Se você sentir a necessidade de criar algo mais suave, comece com um tutorial (se nenhum ainda estiver disponível) e depois parta para a documentação. Se já existir um tutorial mas ele não cobre os comandos que você quer documentar, pense em editar algum dos tutoriais disponíveis, ou pense se não é o caso de incluir um exemplo ou aplicação.

Classes

  • Classe_1

Constantes

  • Constante_1

Funções

  • Função_1
Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-ShareAlike 3.0 License