This is an old revision of the document!
Table of Contents
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:
//! Brief desciption. /*! A more elaborate description. \tags */
Arquivo
- Devem seguir o padrão abaixo e ter no mínimo as tags \file, \brief e \author:
/*!
\file file name
\brief brief description about the file.
Brief description continued.
More detailed description.
\author (?)
\sa
*/
Classe e Estrutura
Classe e Estrutura
- No caso de classes e estruturas é obrigatório colocar as descrições breve e detalhada. A tag \sa é opcional.
Exemplo:
//! A brief description of class or struct. /*! A more elaborate description of class or struct. \author (?) \sa other definitions related to the class or struct */
Método
- Os métodos devem conter no mínimo uma descrição breve, a descrição de todos os seus parâmetros (tag \param) e do seu valor de retorno (tag \return). A descrição detalhada é opcional.
//! A brief description. /*! A more elaborate description of class or struct. \param name description \return description */
Membro
- A descrição breve ou detalhada do membro deve vir acima de sua definição.
//! Brief description after the member int firstMember_; //! Brief description after the member int secondMember_; //! Brief description after the member /*! Detailed description after the member */ int thirdMember_;
Macro, Namespace, Constante
- A descrição breve é obrigatória e a descrição detalhada é opcional.
Exemplo:
//! A brief description. /*! A more elaborate description. */