Diferenças

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

--- twsg:dicas:code_conventions [2009/01/07 18:02] – emerson
+++ twsg:dicas:code_conventions [2009/03/29 01:00] (atual) – emerson
@@ Linha 26: / Linha 26: @@
 Estes componentes são discutidos brevemente nas subseções seguintes.
 ==== License header ====
@@ Linha 53: / Linha 55: @@
 </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 ====
@@ Linha 65: / Linha 73: @@
  */
 </code>
@@ Linha 70: / Linha 79: @@
 ==== 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>
 #ifndef  __TERRAOGC_COMMON_INTERNAL_TECGIUTILS_H
@@ Linha 147: / Linha 156: @@
-===== Dicas doxygen =====
-Documentar bem o código é essencial para o sucesso do projeto como um todo. Uma boa referência para os comandos doxygen pode ser encontrada no [[http://www.stack.nl/~dimitri/doxygen/commands.html|link]].
-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> fica:
-    * OracleSpatial
-    * PostgreSQL
-    * PostGIS