Divisão de Observação da Terra e Geoinformática

Ferramentas do usuário

Ferramentas do site

Visitou:
terralib:padraodocumentacao

Diferenças

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

Link para esta página de comparações

Ambos lados da revisão anteriorRevisão anterior
Próxima revisão		Revisão anterior
terralib:padraodocumentacao [2008/04/02 15:18] – 150.163.3.123terralib:padraodocumentacao [2008/04/02 18:45] (atual) – laercio
Linha 1: Linha 1:
 ====== Documentação DOxygen ====== ====== Documentação DOxygen ======
 \\ \\
-O objetivo dessa parte é padronizar os comentários utilizando tags do DOxygen (http://www.stack.nl/~dimitri/doxygen), a fim de documentar o código de maneira padronizada e automática. O estilo adotado será o Qt (http://www.stack.nl/~dimitri/doxygen/docblocks.html) sem os *'s intermediários. Exemplo:+O objetivo dessa parte é padronizar os comentários utilizando tags do DOxygen (http://www.stack.nl/~dimitri/doxygen), a fim de documentar o código de maneira padronizada e automática. O estilo adotado será o Qt (http://www.stack.nl/~dimitri/doxygen/docblocks.html) sem os *'s intermediários. \\ Exemplo:
 <code cpp> <code cpp>
 +//!  Brief description. 
 /*! /*!
- ... descritption ...+  A more elaborate description. 
 +      
 +  \tags
 */ */
 </code> </code>
    
 +Algumas regras:
 +   * toda documentação deve ser escrita imediatamente antes das definições dos tipos, evitando assim o uso de tags estruturais (\class, \struct, \enum, \def, etc). Para maiores detalhes ver (http://www.stack.nl/~dimitri/doxygen/docblocks.html).
 +   * toda documentação deve ter no mínimo a descrição breve. A documentação detalhada e uso de tags, em alguns casos, não é necessária. \\ Exemplo:
 +
 +<code cpp>
 +...
 +  //!  Empty contructor 
 +  TePolygon(void);
 +...
 +</code>
 +
 +
 +
  
  
Linha 21: Linha 37:
    More detailed description.    More detailed description.
  
-  \author (?)+  \author 
 +  \version
   \sa   \sa
 */ */
 </code>   </code>  
    
 +
 +
 +
 +
 +
  
  
Linha 45: Linha 67:
 /*! /*!
   A more elaborate description of class or struct.   A more elaborate description of class or struct.
 +
   \author (?)   \author (?)
   \sa  other definitions related to the class or struct     \sa  other definitions related to the class or struct  
Linha 56: Linha 79:
 //!  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>  
Linha 67: Linha 91:
 <code cpp> <code cpp>
  
-//! Brief description after the member+//! Brief description 
 int firstMember_;     int firstMember_;    
  
-//!< Brief description after the member+//! Brief description 
 int secondMember_;    int secondMember_;   
  
-//!< Brief description after the member+//! Brief description 
 /*! /*!
-     Detailed description after the member+  Detailed description 
 */ */
 int thirdMember_;     int thirdMember_;    
 </code>   </code>  
  
 +
 +
 +
 +===== Enumeração  =====
 +
 +    * A descrição breve do tipo e de seus valores são obrigatórias. A descrição detalhada é opcional. \\ Exemplo:
 +<code cpp>
 +//! Brief description about enum
 +/*!
 +  A more elaborate description.
 +
 +  \sa ...
 +*/
 +enum TEnum 
 +{ 
 +   TVal1, //!< brief description about enum value TVal1.  
 +   TVal2, //!< brief description about enum value TVal2.   
 +   TVal3  //!< brief description about enum value TVal3.   
 +} 
 +</code>  
  
 ===== Macro, Namespace, Constante  ===== ===== Macro, Namespace, Constante  =====
terralib/padraodocumentacao.1207149507.txt.gz · Última modificação: 2008/04/02 15:18 por 150.163.3.123