Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
terralib:resumo [2008/04/01 11:57] laercio |
terralib:resumo [2008/04/02 12:39] (current) 150.163.3.123 |
||
|---|---|---|---|
| Line 1: | Line 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** | ||
| Line 13: | Line 13: | ||
| - | ==== 1.2 Estrutura ==== | + | ==== Estrutura ==== |
| * ''<Enter>'' na última linha | * ''<Enter>'' na última linha | ||
| * Máximo de 80 colunas por linha | * Máximo de 80 colunas por linha | ||
| Line 44: | Line 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: | ||
| Line 51: | Line 51: | ||
| <code cpp> | <code cpp> | ||
| /*! | /*! | ||
| - | \file file name | + | \file file name |
| - | \brief brief description about the file. | + | \brief brief description about the file. |
| - | Brief description continued. | + | Brief description continued. |
| | | ||
| - | More detailed description. | + | More detailed description. |
| - | \author (?) | + | \author (?) |
| */ | */ | ||
| </code> | </code> | ||
| Line 66: | Line 66: | ||
| - | ==== 1.4 Exemplo ==== | + | ==== Exemplo ==== |
| [[terralib:exemplo1|Veja exemplo]] | [[terralib:exemplo1|Veja exemplo]] | ||
| Line 76: | Line 76: | ||
| - | ===== 2. Macro ===== | + | ===== Macro ===== |
| ==== Nome ==== | ==== Nome ==== | ||
| Line 100: | Line 100: | ||
| //! A brief description. | //! A brief description. | ||
| /*! | /*! | ||
| - | A more elaborate description. | + | A more elaborate description. |
| */ | */ | ||
| </code> | </code> | ||
| Line 110: | Line 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 | ||
| </code> | </code> | ||
| Line 134: | Line 133: | ||
| //! A brief description. | //! A brief description. | ||
| /*! | /*! | ||
| - | A more elaborate description. | + | A more elaborate description. |
| */ | */ | ||
| </code> | </code> | ||
| Line 192: | Line 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 | ||
| + | |||
| Line 216: | Line 216: | ||
| //! A brief description of class or struct. | //! A brief description of class or struct. | ||
| /*! | /*! | ||
| - | A more elaborate description of class or struct. | + | A more elaborate description of class or struct. |
| - | \sa other definitions related to the class or struct | + | |
| + | \sa other definitions related to the class or struct | ||
| */ | */ | ||
| </code> | </code> | ||
| Line 227: | Line 228: | ||
| //! A brief description. | //! A brief description. | ||
| /*! | /*! | ||
| - | A more elaborate description of class or struct. | + | A more elaborate description of class or struct. |
| - | \param name description | + | |
| - | \return description | + | \param name description |
| + | \return description | ||
| */ | */ | ||
| </code> | </code> | ||
| === Membro === | === Membro === | ||
| - | * A descrição do membro deve vir depois de sua definição. | + | |
| - | + | ||
| - | <code cpp> | + | |
| - | int member01_; //!< Brief description after the member | + | |
| - | int member02_; //!< Brief description after the member | + | |
| - | </code> | + | |
