prog1:estilo
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
prog1:estilo [2024/03/07 21:12] – código limpo - geral beco | prog1:estilo [2024/03/07 21:47] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 25: | Line 25: | ||
- aceite o convite para o time do BecoSystems da disciplina/ | - aceite o convite para o time do BecoSystems da disciplina/ | ||
- acesse o link do GitHub classroom para iniciar uma atividade (pegue o link com o professor) | - acesse o link do GitHub classroom para iniciar uma atividade (pegue o link com o professor) | ||
- | * Siga o código de [[prog1: | + | * Siga o código de [Código de Conduta BecoSystems](conduta) |
# Repositório | # Repositório | ||
Line 95: | Line 95: | ||
- Linguagem C: ex11.c e ex11 ou ex11.x | - Linguagem C: ex11.c e ex11 ou ex11.x | ||
- Biblioteca em C: ex11.h | - Biblioteca em C: ex11.h | ||
+ | - Linguagem C++: ex11.cpp e ex11.out | ||
+ | - Biblioteca em C++: ex11.hpp | ||
+ | - Linguagem Rust: ex11.rs e ex11 | ||
+ | - Linguagem Zig: ex11.zig e ex11 | ||
- PROLOG: ex11.pl (e se houver, ex11.pl.x) | - PROLOG: ex11.pl (e se houver, ex11.pl.x) | ||
- Portugol: ex11.gpt e ex11.gpt.x | - Portugol: ex11.gpt e ex11.gpt.x | ||
- Texto Markdown: ex11.md | - Texto Markdown: ex11.md | ||
+ | - Texto Wiki: ex11.wiki | ||
- Bash Script: ex11.sh | - Bash Script: ex11.sh | ||
- Assembly: ex11.s (sintaxe AT&T) | - Assembly: ex11.s (sintaxe AT&T) | ||
Line 207: | Line 212: | ||
### Comentários | ### Comentários | ||
- | * Use comentários /* estilo C */ | + | * Use comentários |
- | * Coloque um espaço após o /* e um antes do */ | + | * Coloque um espaço após o `/*` e um antes do `*/` |
* Faça comentários _em linha_ nas declarações de variável. `int i; /* indice geral */` | * Faça comentários _em linha_ nas declarações de variável. `int i; /* indice geral */` | ||
* Evite comentários em linha em outros locais | * Evite comentários em linha em outros locais | ||
Line 215: | Line 220: | ||
* Não use acentos (nem c-cedilhas) no código ou comentários | * Não use acentos (nem c-cedilhas) no código ou comentários | ||
* Use as palavras nos comentários: | * Use as palavras nos comentários: | ||
- | - /* TODO: alguma tarefa */ : para indicar algo que falta fazer | + | - `/* TODO: alguma tarefa */` : para indicar algo que falta fazer |
- | - /* BUG: esta errado assim e assado */ : para indicar um bug conhecido que precisa ser corrigido no futuro. | + | - `/* BUG: esta errado assim e assado */` : para indicar um bug conhecido que precisa ser corrigido no futuro. |
### Comentários DOXYGEN | ### Comentários DOXYGEN | ||
Line 363: | Line 368: | ||
# Teste | # Teste | ||
- | * Não tenha pressa de fazer _push_! | + | * Não tenha pressa de fazer _commit_ e _push_! |
* Compile. Use todas as chaves de aviso que o _gcc_ pode oferecer. O _gcc_ é seu amigo! | * Compile. Use todas as chaves de aviso que o _gcc_ pode oferecer. O _gcc_ é seu amigo! | ||
* Crie páginas com mensagens de erro com o comando _sprunge_ para discutir nos _issues_ se necessário | * Crie páginas com mensagens de erro com o comando _sprunge_ para discutir nos _issues_ se necessário | ||
Line 369: | Line 374: | ||
- Não deixe de conhecer as opções do _gcc_ para compilação. Este é um comando fundamental em vários sistemas operacionais, | - Não deixe de conhecer as opções do _gcc_ para compilação. Este é um comando fundamental em vários sistemas operacionais, | ||
* Teste! Rode o programa, faça entrada de dados, veja se o que acabou de programar realmente faz o que você deseja, e se não quebrou nada em outra função do programa. | * Teste! Rode o programa, faça entrada de dados, veja se o que acabou de programar realmente faz o que você deseja, e se não quebrou nada em outra função do programa. | ||
- | * Tudo ok? Então faça o _push_! | + | * Tudo ok? O programa compila sem erros e avisos? Está quase na hora do _commit_ então... Mas falta algo importante: indentação! |
+ | * Use um formatador automático (veja o _astyle_). Verifique o código. Agora sim, além de compilar sem erros, também está um **CÓDIGO LIMPO**. | ||
+ | * Então | ||
+ | * Você pode editar mais, fazer mais _commits_. No final do trabalho, ou quando achar que é hora, faça o _push_! | ||
* Se o trabalho exige _pull request_, faça suas modificações chegarem até o _master_ e então faça o _pull request_ do seu _master_ (_origin_) para o _master_ do _upstream_. | * Se o trabalho exige _pull request_, faça suas modificações chegarem até o _master_ e então faça o _pull request_ do seu _master_ (_origin_) para o _master_ do _upstream_. | ||
* No _pull request_ coloque um título descritivo. Se seu trabalho é em grupo, coloque também no início do título o número do grupo. | * No _pull request_ coloque um título descritivo. Se seu trabalho é em grupo, coloque também no início do título o número do grupo. |
prog1/estilo.1709856733.txt.gz · Last modified: 2024/03/07 21:12 by beco