Ferramentas do usuário

Ferramentas do site


terralib:resumo

Diferenças

Aqui você vê as diferenças entre duas revisões dessa página.

Link para esta página de comparações

Próxima revisão
Revisão anterior
terralib:resumo [2008/04/01 14:57] – created laercioterralib:resumo [2008/04/02 15:39] (atual) 150.163.3.123
Linha 1: Linha 1:
-===== 1. Arquivo =====+====== Resumo e Exemplos ======
  
 +===== Arquivo =====
  
  
-==== 1.1 Nome ====+ 
 +==== Nome ====
     * UpperCamelCase + prefixo **Te**     * UpperCamelCase + prefixo **Te**
     * Extensão **.h** e **.cpp**     * Extensão **.h** e **.cpp**
Linha 11: Linha 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
Linha 42: 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 49: Linha 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>  
Linha 64: Linha 66:
  
  
-==== 1.4 Exemplo ====+==== Exemplo ====
 [[terralib:exemplo1|Veja exemplo]] [[terralib:exemplo1|Veja exemplo]]
  
Linha 74: Linha 76:
  
  
-===== 2. Macro =====+===== Macro =====
  
 ==== Nome ==== ==== Nome ====
Linha 98: Linha 100:
 //!  A brief description.  //!  A brief description. 
 /*! /*!
-     A more elaborate description.+  A more elaborate description.
 */ */
 </code>   </code>  
Linha 108: 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
 </code> </code>
Linha 132: Linha 133:
 //!  A brief description.  //!  A brief description. 
 /*! /*!
-     A more elaborate description.+  A more elaborate description.
 */ */
 </code>   </code>  
Linha 190: 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 214: Linha 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>  
Linha 225: Linha 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>  +
  
  
terralib/resumo.1207061821.txt.gz · Última modificação: 2008/04/01 14:57 por laercio