Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
pt:manual:contrib:coding_style_guidelines [2020/11/19 02:34] i3_relativism [Descricao] |
pt:manual:contrib:coding_style_guidelines [2024/10/25 15:34] (current) luck02 [Descrição] |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Diretrizes | + | ...(WIP) |
+ | ====== Diretrizes | ||
- | ===== Descricao | + | ===== Descrição |
- | Este artigo especifica o estilo | + | Este artigo especifica o modelo |
<code c> | <code c> | ||
/* | /* | ||
- | * Guia de Estilo de o HyperbolaBSD KNF (Kernel Normal Form). | + | * Guia do modelo do HyperbolaBSD KNF (Kernel Normal Form). |
*/ | */ | ||
/* | /* | ||
- | | + | |
*/ | */ | ||
- | /* A maior parte de os comentarios | + | /* A maior parte dos comentários |
/* | /* | ||
Line 21: | Line 22: | ||
</ | </ | ||
- | Os ficheiros | + | Os arquivos |
<code c> | <code c> | ||
- | #include < | + | #include < |
</ | </ | ||
- | Se for um programa de rede, ponha od ficheiros | + | Se for um programa de rede, ponha o arquivo |
<code c> | <code c> | ||
Line 36: | Line 37: | ||
</ | </ | ||
- | Deixe uma linha em branco, seguida por ficheiros<color # | + | Deixe uma linha em branco, seguida por arquivos<color # |
- | Pathnames globais | + | Pathnames globais |
<code c> | <code c> | ||
Line 44: | Line 45: | ||
</ | </ | ||
- | Deixe uma linha em branco, seguida | + | Deixe uma linha em branco, seguida |
<code c> | <code c> | ||
- | #include " | + | #include " |
</ | </ | ||
- | Todas as funcoes | + | Todas as funções |
- | Prototipos de funcoes | + | Prototipos de funções |
- | Funcoes | + | Funções |
- | Funcoes | + | Funções |
- | Prototipos | + | Prototipos |
<code c> | <code c> | ||
Line 70: | Line 71: | ||
</ | </ | ||
- | Prototipos poderam ter um espaco | + | Prototipos poderam ter um espaço |
<code c> | <code c> | ||
Line 77: | Line 78: | ||
</ | </ | ||
- | Nao devera | + | Não deverá |
Utilize <color # | Utilize <color # | ||
Line 85: | Line 86: | ||
</ | </ | ||
- | Nos ficheiros | + | Nos arquivos |
- | Macros | + | Macros |
<code c> | <code c> | ||
Line 96: | Line 97: | ||
</ | </ | ||
- | Valores de enumeracao sao todos em **!? | + | Valores de enumeração são todos em **!? |
<code c> | <code c> | ||
Line 102: | Line 103: | ||
</ | </ | ||
- | Na definicao de integers | + | Na definicao de integers |
- | Na declaracao | + | Na declaração |
- | Estruturas mais relevantes deveram ser declaradas no topo do ficheiro | + | Estruturas mais relevantes deveram ser declaradas no topo do arquivo |
<code c> | <code c> | ||
Line 117: | Line 118: | ||
</ | </ | ||
- | Utilize macros <color # | + | Utilize macros <color # |
<code c> | <code c> | ||
Line 129: | Line 130: | ||
</ | </ | ||
- | Evite utilizar typedefs para estruturas. Pois isto impossiblita o uso de pointers de uma foma opaca por parte das aplicacoes, que e tanto possivel | + | Evite utilizar typedefs para estruturas. Pois isto impossiblita o uso de pointers de uma foma opaca por parte das aplicações, que e tanto possível |
<code c> | <code c> | ||
Line 144: | Line 145: | ||
</ | </ | ||
- | Para haver consistencia, | + | Para haver consistencia, |
<code c> | <code c> | ||
Line 170: | Line 171: | ||
</ | </ | ||
- | Utilize um espaco | + | Utilize um espaço |
<code c> | <code c> | ||
Line 188: | Line 189: | ||
</ | </ | ||
- | Algumas partes de um <color # | + | Algumas partes de um <color # |
<code c> | <code c> | ||
Line 197: | Line 198: | ||
</ | </ | ||
- | Identacao e um **!?tab?!** de 8 caractres. | + | Identação é um **!?tab?!** de 8 caractres. |
<code c> | <code c> | ||
Line 206: | Line 207: | ||
</ | </ | ||
- | Nao adicione | + | Não adicione |
- | Abertura e fecho de parentises apresentam-se na mesma linha que os anteriores. Parentises desnecessarios | + | Abertura e fechamento |
<code c> | <code c> | ||
Line 220: | Line 221: | ||
</ | </ | ||
- | Nao utilize | + | Não utilize |
<code c> | <code c> | ||
Line 227: | Line 228: | ||
</ | </ | ||
- | Operadores unitarios | + | Operadores unitarios |
<code c> | <code c> | ||
Line 234: | Line 235: | ||
</ | </ | ||
- | Exits deverao | + | Exits deverão |
<code c> | <code c> | ||
/* | /* | ||
- | * Tente evitar | + | * Tente evitar |
* "Exit 0 com successo." | * "Exit 0 com successo." | ||
*/ | */ | ||
Line 244: | Line 245: | ||
</ | </ | ||
- | Esta tipo de funcao devera | + | Este tipo de função deverá |
<code c> | <code c> | ||
Line 252: | Line 253: | ||
</ | </ | ||
- | Ao declarar | + | Ao declarar |
- | enha cuidade | + | Tenha cuidado |
<code c> | <code c> | ||
Line 265: | Line 266: | ||
</ | </ | ||
- | Nao declare | + | Não declare |
Casts and <color # | Casts and <color # | ||
- | A utilizacao | + | A utilização |
- | Na utilizacao | + | Na utilização |
<code c> | <code c> | ||
Line 277: | Line 278: | ||
</ | </ | ||
- | Se qualquer erro de este tipo ocurrer, devera | + | Se qualquer erro deeste |
<code c> | <code c> | ||
Line 295: | Line 296: | ||
</ | </ | ||
- | “< | + | “< |
<code c> | <code c> | ||
Line 303: | Line 304: | ||
Bandeiras globais defenidas dentro de **!? | Bandeiras globais defenidas dentro de **!? | ||
- | NULL e a contaste preferida para apontadores nulos. Utilize <color # | + | NULL e a contaste preferida para apontadores nulos. Utilize <color # |
- | Nao utilize ‘< | + | Não utilize ‘< |
<code c> | <code c> | ||
Line 311: | Line 312: | ||
</ | </ | ||
- | nao | + | não |
<code c> | <code c> | ||
Line 317: | Line 318: | ||
</ | </ | ||
- | **!? | + | **!? |
- | Utilize as familias de funcoes | + | Utilize as familias de funções |
<code c> | <code c> | ||
Line 329: | Line 330: | ||
</ | </ | ||
- | Funcoes de estilo | + | Funções desse modelo do antigo apresentam-se desta maneira: |
<code c> | <code c> | ||
Line 342: | Line 343: | ||
</ | </ | ||
- | Utilize | + | Utilize |
Numeros variaveis de argumentos devem-se apresentar desta maneira: | Numeros variaveis de argumentos devem-se apresentar desta maneira: | ||
Line 367: | Line 368: | ||
</ | </ | ||
- | Expressoes | + | Expressões |
- | Utilize uma barra (‘< | + | Utilize uma barra (‘< |
Se numeros sao utilizados como opcoes, estes deveram se apresentar primeiro, como mostra o exemplo a baixo. letras em **Uppercase** tem precedencia de letras em **lowercase**. | Se numeros sao utilizados como opcoes, estes deveram se apresentar primeiro, como mostra o exemplo a baixo. letras em **Uppercase** tem precedencia de letras em **lowercase**. | ||
Line 384: | Line 385: | ||
</ | </ | ||
- | Novo codigo | + | Novo código |
- | Sempre que possivel, codigo devera correr atraves | + | Sempre que possível, código deverá rodar através |
- | Verifique que certa documentacao | + | Verifique que certa documentação |
- | ===== Historia | + | ===== História |
- | Este artigo | + | Este artigo |
- | ===== Licensiamento | + | ===== Licenciamento |
- | Este artigo wiki esta publica | + | Este artigo |
===== Créditos ===== | ===== Créditos ===== | ||
- | Este artigo wiki está baseado | + | Este artigo wiki estar baseado |