Referenciado por: Análise de Interfaces | Como Criar Novo Serviço REST | Dicas Técnicas | Estrutura de Pastas | Filosofias de Programação | Predefinição:Guia de programação | Padrões de Interface do Commerce | Padrões de Programação em Delphi | Padrões para uso de componentes em Delphi |
| Guia de programação | |
| Padrões Delphi | |
| Filosofias | |
| Interface Commerce | |
| Uso de componentes | |
| Mais sobre Interface | |
| Documentação em Fontes | |
| Estrutura de Pastas |
Esse documento descreve como fazer documentações em fontes de Delphi suportadas pelo Enterprise Architect e DelphiToDoc.
Esses conceitos foram aplicados às classes de impostos.
Exemplos de Utilização
Unit
Exemplo de documentação de unit.
{** * Unit para a classe TContador. * * Manutenções: * PETTERS 80000 - Correção do bug tal. * <Usuário do SAC> <Número da tarefa> - <título da tarefa> * * Customizações: * <Usuário do SAC> <Número da tarefa> - <título da tarefa> * * @Author Totali Sistemas Ltda *}
Classe
Exemplo de documentação de classe.
{** * Representação de um contabilista. *} TContador = class(TTotaliObject)
Atributo
Exemplo de documentação de atributo.
/// CPF do cliente FNumDoc: string;
Propriedade
Exemplo de documentação de propriedade.
/// Informar o CPF do cliente. property NumDoc: String read FNumDoc write FNumDoc;
Método
Exemplo de documentação de método.
{** * Substitui o(s) espaço(s) à esquerda de uma string por outro caractere. * * @param expressao String Texto para ser formatado. * @param caractere Char Caracter que será utilizado na substituição. * @param quantidade Integer Tamanho do texto. * @return String Texto formatado. *} function LPad(expressao: string; caractere: char; quantidade: integer): string;
Pode-se utilizar (* ou *) caso precise incluir chaves na documentação.
Mais informações
O EA não suporta os comandos com @, mas suporta inclusão de tags HTML na documentação (padrão do JavaDoc). Mas como o objetivo é facilitar a visualização no próprio Delphi, o padrão é não utilizar as tags HTML e utilizar os seguintes comandos com @.
Lista das tags suportadas:
- Description (sem '@' TAG)
- @author
- @version
- @param
- @return
- @throws
- @todo
- @Comment
- @see