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

Ferramentas do usuário

Ferramentas do site

Visitou:
twsg:dicas:code_conventions

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
twsg:dicas:code_conventions [2009/01/07 17:56] – Dicas doxygen 2 emersontwsg:dicas:code_conventions [2009/03/29 01:00] (atual) – emerson
Linha 26: Linha 26:
  
 Estes componentes são discutidos brevemente nas subseções seguintes. Estes componentes são discutidos brevemente nas subseções seguintes.
 +
 +
  
 ==== License header ==== ==== License header ====
Linha 53: Linha 55:
 </code> </code>
  
 +Para adicionar o //License header// a um conjunto de arquivos já existentes numa pasta, você pode usar o seguinte comando no Linux: <code bash>
 +for i in `find . -name "*.js"`; do cp $i $i.bkp; cat ../header.txt $i.bkp > $i; rm -f $i.bkp; done
 +</code>
 +Apenas altere o ''*.js'' para a extensão dos seus arquivos e crie o arquivo ''header.txt'' na pasta abaixo, com o conteúdo descrito neste tópico. Para personalizar ainda mais o comando basta olhar o funcionamento do comando ''find'' do shell. Por exemplo, você quer colocar o //License header// em todos os arquivos .h e .cpp de uma pasta, então você pode criar o ''header.txt'' com o conteúdo correto (lembrar de deixar uma linha em branco no final) e executar o seguinte comando nesta pasta: <code bash>
 +for i in `find . -name "*.h" -or -name "*.cpp"`; do cp $i $i.bkp; cat header.txt $i.bkp > $i; rm -f $i.bkp; done
 +</code>
  
 ==== File identification ==== ==== File identification ====
Linha 65: Linha 73:
  */  */
 </code> </code>
 +
  
  
Linha 70: Linha 79:
 ==== Header file guard ==== ==== Header file guard ====
  
-As convenções do File header guard estão descritas no documento de referência. A pŕincipal alteração é a troca do prefixo ''OGWS'' por ''TERRAOGC'', segundo exemplo abaixo:+As convenções do File header guard estão descritas no documento de referência. A principal alteração é a troca do prefixo ''OGWS'' por ''TERRAOGC'', segundo exemplo abaixo:
 <code cpp> <code cpp>
 #ifndef  __TERRAOGC_COMMON_INTERNAL_TECGIUTILS_H #ifndef  __TERRAOGC_COMMON_INTERNAL_TECGIUTILS_H
Linha 143: Linha 152:
  
  
-===== Dicas doxygen ===== 
  
-Documentar bem o código é essencial para o sucesso do projeto como um todo. Veja algumas dicas: 
-  - Para obter o efeito de **negrito**, você pode usar o comando ''\b'' antes da palavra que deseja destacar. Para mais de uma palavra use como em HTML. Exemplos: 
-    * \b must => **must** 
-    * <b>must use</b> => **must use** 
-  - Para destacar uma palavra em //itálico// use o comando ''\a''. Para múltiplas palavras coloque entre as tags <i> e </i>. Exemplos: 
-    * \a loadInstances => //loadInstances// 
-    * <i>loadInstances method</i> => //loadInstances method// 
-  - Para um efeito de fonte ''monospace'', use o comando ''\c''. Para múltiplas palavras use as tags <tt></tt>. Exemplos: 
-    * \c sessionId => ''sessionID'' 
-    * <tt>sessionId parameter</tt> => ''sessionID parameter'' 
  
-  - Para usar uma lista sem numeração (como os exemplos acima), preceda cada termo com o comando ''\li''. Exemplo: <code> + 
-\li OracleSpatial + 
-\li PostgreSQL + 
-\li PostGIS </code> => + 
-    * OracleSpatial +
-    * PostgreSQL +
-    * PostGIS+
  
  
twsg/dicas/code_conventions.1231350997.txt.gz · Última modificação: 2009/01/07 17:56 por emerson