terralib:resumo
Diferenças
Aqui você vê as diferenças entre duas revisões dessa página.
| Ambos lados da revisão anteriorRevisão anteriorPróxima revisão | Revisão anterior | ||
| terralib:resumo [2008/04/01 14:57] – laercio | terralib:resumo [2008/04/02 15:39] (atual) – 150.163.3.123 | ||
|---|---|---|---|
| Linha 1: | Linha 1: | ||
| ====== Resumo e Exemplos ====== | ====== Resumo e Exemplos ====== | ||
| - | ===== 1. Arquivo ===== | + | ===== Arquivo ===== |
| - | ==== 1.1 Nome ==== | + | ==== Nome ==== |
| * UpperCamelCase + prefixo **Te** | * UpperCamelCase + prefixo **Te** | ||
| * Extensão **.h** e **.cpp** | * Extensão **.h** e **.cpp** | ||
| Linha 13: | Linha 13: | ||
| - | ==== 1.2 Estrutura ==== | + | ==== Estrutura ==== |
| * ''< | * ''< | ||
| * Máximo de 80 colunas por linha | * Máximo de 80 colunas por linha | ||
| Linha 44: | Linha 44: | ||
| - | ==== 1.3 Comentário ==== | + | ==== Comentário ==== |
| * Todo **.h** terá um cabeçalho padrão contendo informações sobre licença, parceiros, etc. | * Todo **.h** terá um cabeçalho padrão contendo informações sobre licença, parceiros, etc. | ||
| * Os comentários para gerar a documentação DOxygen: | * Os comentários para gerar a documentação DOxygen: | ||
| Linha 51: | Linha 51: | ||
| <code cpp> | <code cpp> | ||
| /*! | /*! | ||
| - | | + | |
| - | \brief | + | \brief |
| - | Brief description continued. | + | Brief description continued. |
| | | ||
| - | More detailed description. | + | More detailed description. |
| - | | + | |
| */ | */ | ||
| </ | </ | ||
| Linha 66: | Linha 66: | ||
| - | ==== 1.4 Exemplo ==== | + | ==== Exemplo ==== |
| [[terralib: | [[terralib: | ||
| Linha 76: | Linha 76: | ||
| - | ===== 2. Macro ===== | + | ===== Macro ===== |
| ==== Nome ==== | ==== Nome ==== | ||
| Linha 100: | Linha 100: | ||
| //! A brief description. | //! A brief description. | ||
| /*! | /*! | ||
| - | A more elaborate description. | + | |
| */ | */ | ||
| </ | </ | ||
| Linha 110: | Linha 110: | ||
| #define TE_CONNECTION_POOL_H | #define TE_CONNECTION_POOL_H | ||
| .... | .... | ||
| - | #define TE_MAX_FLOAT 3.4e37 | + | |
| - | .... | + | |
| #endif //end TE_CONNECTION_POOL_H | #endif //end TE_CONNECTION_POOL_H | ||
| </ | </ | ||
| Linha 134: | Linha 133: | ||
| //! A brief description. | //! A brief description. | ||
| /*! | /*! | ||
| - | A more elaborate description. | + | |
| */ | */ | ||
| </ | </ | ||
| Linha 192: | Linha 191: | ||
| * Usar “other” para nomes de parâmetros nos construtores de cópia e operadores de atribuição | * Usar “other” para nomes de parâmetros nos construtores de cópia e operadores de atribuição | ||
| * Usar os mesmos nomes dos membros nos métodos que os acessam diretamente | * Usar os mesmos nomes dos membros nos métodos que os acessam diretamente | ||
| + | |||
| Linha 216: | Linha 216: | ||
| //! A brief description of class or struct. | //! A brief description of class or struct. | ||
| /*! | /*! | ||
| - | A more elaborate description of class or struct. | + | |
| - | | + | |
| + | | ||
| */ | */ | ||
| </ | </ | ||
| Linha 227: | Linha 228: | ||
| //! A brief description. | //! A brief description. | ||
| /*! | /*! | ||
| - | A more elaborate description of class or struct. | + | |
| - | | + | |
| - | | + | |
| + | \return description | ||
| */ | */ | ||
| </ | </ | ||
| === Membro === | === Membro === | ||
| - | * A descrição do membro deve vir depois de sua definição. | + | |
| - | + | ||
| - | <code cpp> | + | |
| - | int member01_; | + | |
| - | int member02_; | + | |
| - | </ | + | |
terralib/resumo.1207061847.txt.gz · Última modificação: 2008/04/01 14:57 por laercio
