Mudanças entre as edições de "Manual do Desenvolvedor"
De Grupo Acert
(Criou página com '== Introdução == Este documento tem por objetivo orientar a codificação de sistemas. Os assuntos que serão abordados trata a sistemática de adoção de padrões de codific...') |
|||
| Linha 29: | Linha 29: | ||
'''Public''' - Todas as classes podem acessar. | '''Public''' - Todas as classes podem acessar. | ||
| + | |||
| + | == Documentação da classe == | ||
| + | |||
| + | Cada classe começa com um comentário “/** ... */” descrevendo: | ||
| + | |||
| + | * O propósito da classe; | ||
| + | * Instruções de uso; | ||
| + | * Exemplos de uso (opcional); | ||
| + | * Informações sobre possíveis melhoramentos, defeitos existentes ou manutenções efetuadas na classe; | ||
| + | * Nome dos autores; | ||
| + | * Referências úteis para o entendimento da classe. | ||
| + | |||
| + | Em seguida, tem-se a declaração do nome da classe que faz parte da codificação do sistema. | ||
| + | |||
| + | /** | ||
| + | * Descrição da classe | ||
| + | * | ||
| + | * Exemplo de uso: | ||
| + | * <pre> | ||
| + | * algum Código | ||
| + | * </pre> | ||
| + | * | ||
| + | * Limitações: | ||
| + | * | ||
| + | * @author <nome do autor> | ||
| + | * @version <versão da classe> | ||
| + | * @see br.gov.agricultura.Componente | ||
| + | */ | ||
