Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
twsg:dicas:code_conventions [2009/01/07 15:46] emerson |
twsg:dicas:code_conventions [2009/03/28 22:00] (current) emerson |
||
|---|---|---|---|
| Line 26: | Line 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 ==== | ||
| Line 53: | Line 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 ==== | ||
| Line 65: | Line 73: | ||
| */ | */ | ||
| </code> | </code> | ||
| + | |||
| Line 70: | Line 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 | ||
| Line 141: | Line 150: | ||
| - | ===== 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. Exemplo: \b must => **must**. Para mais de uma palavra use como em HTML: <b>must use</b> | + | |
| + | |||
| + | |||
| + | |||
| + | |||
