|
| 1 | +# Algoritmos de Ordenação (Delphi) |
| 2 | + |
| 3 | +>Mostra visualmente os diversos algoritmos de ordenação, desenvolvido em Delphi. |
| 4 | +
|
| 5 | +<br /> |
| 6 | + |
| 7 | + |
| 8 | + |
| 9 | + |
| 10 | + |
| 11 | + |
| 12 | + |
| 13 | + |
| 14 | + |
| 15 | + |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | + |
| 20 | + |
| 21 | + |
| 22 | + |
| 23 | + |
| 24 | + |
| 25 | + |
| 26 | + |
| 27 | + |
| 28 | + |
| 29 | + |
| 30 | + |
| 31 | + |
| 32 | +<br /> |
| 33 | + |
| 34 | +******* |
| 35 | +## Índice |
| 36 | + 1. [Uso](#uso) |
| 37 | + 2. [Sitemap](#sitemap) |
| 38 | + 3. [Estrutura](#estrutura) |
| 39 | + 4. [Workgroup](#workgroup) |
| 40 | + 5. [Dependências](#dependencias) |
| 41 | + 6. [Contribuir](#contribuir) |
| 42 | + 7. [Checklist para Contribuir](#checklist) |
| 43 | + 8. [Créditos](#creditos) |
| 44 | + 9. [Licença](#licenca) |
| 45 | + 10. [Padronização de Código](#source) |
| 46 | + 11. [TODO](#todo) |
| 47 | + 12. [Árvore do Projeto](#arvore) |
| 48 | +******* |
| 49 | + |
| 50 | +<br /> |
| 51 | + |
| 52 | +## Uso <a name="uso"></a> |
| 53 | + |
| 54 | +<br /> |
| 55 | + |
| 56 | +## [Sitemap](https://coggle.it) <a name="sitemap"></a> |
| 57 | + |
| 58 | + |
| 59 | +<br /> |
| 60 | + |
| 61 | +## Estrutura <a name="estrutura"></a> |
| 62 | ++ **app:** Contém a compilação do(s) pacote(s) e tela de demonstração; |
| 63 | ++ **documentation:** Contém a documentação do(s) pacote(s); |
| 64 | ++ **images:** Contém as imagens usadas no(s) pacote(s); |
| 65 | ++ **modules:** Contém os algoritmos de ordenação, cada módulo (pacote) corresponde à um algoritmo específico; |
| 66 | ++ **output:** Contém os arquivos pré compilados usados pelo Delphi (.dcu); |
| 67 | ++ **project:** Diretório com os projetos de cada pacote e visualizador; |
| 68 | ++ **src:** Contém o fonte do visualizador e fontes comuns a todos; |
| 69 | ++ **vendor:** Contém os pacotes de terceiros; |
| 70 | + |
| 71 | +<br /> |
| 72 | + |
| 73 | +## Workgroup <a name="workgroup"></a> |
| 74 | +Deve-se manter a ordem de compilação do projeto como na imagem. |
| 75 | + |
| 76 | + |
| 77 | + |
| 78 | +<br /> |
| 79 | + |
| 80 | +## Dependências <a name="dependencias"></a> |
| 81 | ++ **Sem dependências até o momento.** |
| 82 | + |
| 83 | +<br /> |
| 84 | + |
| 85 | +## Contribuir <a name="contribuir"></a> |
| 86 | +1. Faça um "fork" com base no master; |
| 87 | +2. Faça "commit" de suas alterações (Caso estiver resolvendo alguma "issue" não esqueça de na mensagem escrever "Fixed #numeroIssue"); |
| 88 | +3. Faça "push" de seus commits; |
| 89 | +4. Solicite um "pull request" para o master do repositório principal. |
| 90 | + |
| 91 | +### Criando uma *Issue* |
| 92 | +Para criar uma *issue* atente para o seguinte: |
| 93 | ++ Selecionar o *label* adequado para a *issue* (esse *label* poderá vir a ser alterado, mas a não designação faz com que a *issue* fique perdida). |
| 94 | + |
| 95 | + |
| 96 | + |
| 97 | ++ Selecionar o projeto *Kanban*, isso organizará o que está sendo feito e o que deverá ser feito. |
| 98 | + |
| 99 | + |
| 100 | + |
| 101 | +<br /> |
| 102 | + |
| 103 | +## Checklist para Contribuir <a name="checklist"></a> |
| 104 | ++ Testar as funcionalidades criadas / alteradas; |
| 105 | ++ Marcar com "#" os issues concluídos, nos commits; |
| 106 | ++ Readme (caso nescessário) |
| 107 | + - Número do build; |
| 108 | + - Alterar indice; |
| 109 | + - Alterar / adicionar forma de uso; |
| 110 | + - Incluir pacotes / classes / métodos / parâmetros nas formas de uso; |
| 111 | + - Alterar sitemap; |
| 112 | + - Alterar estrutura da aplicação; |
| 113 | + - Imagem atualizada do Workgroup; |
| 114 | + - Adicionar / Remover dependências (pacotes de terceiros); |
| 115 | + - Atualizar a documentação do fonte; |
| 116 | + - Remover / adicionar itens ao TODO; |
| 117 | + - Atualizar árvore do projeto; |
| 118 | ++ Ao adicionar itens ao TODO, não esquecer de criar a "issue" correspondente; |
| 119 | + * Labels principais |
| 120 | + - **bug:** Correção de algum problema; |
| 121 | + - **documentation:** Alteração na documentação; |
| 122 | + - **enhacement:** Alteração de funcionalidade existente para melhorá-la; |
| 123 | + - **feature:** Nova funcionalidade; |
| 124 | + * Projeto |
| 125 | + - **Kanban:** Para melhor organizar o projeto; |
| 126 | + |
| 127 | +<br /> |
| 128 | + |
| 129 | +## Créditos <a name="creditos"></a> |
| 130 | +[@bomrafinha](https://github.com/bomrafinha) |
| 131 | + |
| 132 | +<br /> |
| 133 | + |
| 134 | +## [Licença](./LICENSE) <a name="licenca"></a> |
| 135 | + |
| 136 | +<br /> |
| 137 | + |
| 138 | +## Padronização de Código <a name="source"></a> |
| 139 | +### Versionamento |
| 140 | +Para versionar esse repositório deve-se usar como base o versionamento para windows 32 bits do Ordenacao.Executavel.exe, da forma que se segue: |
| 141 | + |
| 142 | + |
| 143 | +#### onde: |
| 144 | +1. Versão principal, só muda quando o funcionamento básico do sistema altera de forma considerável; |
| 145 | +2. Quantidade de módulos funcionais do sistema (cada algoritmo de ordenação representa um módulo); |
| 146 | +3. Quantidade de funções públicas disponíveis no sistema; |
| 147 | +4. Versão de build do sistema auto-gerado pelo Delphi; |
| 148 | +5. Deve-se manter o build como auto incremento; |
| 149 | + |
| 150 | +Para cada teste compilado com sucesso deve-se dar *build* no .exe para versionar (shift + F9). |
| 151 | + |
| 152 | +Os *releases* do repositório serão feitos a cada vez que um módulo estiver 100% finalizado (considerando que um módulo equivale à um algoritmo de ordenação), ou quando um conserto muito relevante for realizado. |
| 153 | + |
| 154 | +<br /> |
| 155 | + |
| 156 | +### Padrões adotados no projeto |
| 157 | +Para um melhor entendimento do projeto foi-se adotado alguns padrões que facilitam a identificação de cada estrutura usada. São, basicamente, o uso de *camelcase*, com variações nas iniciais; |
| 158 | + |
| 159 | +#### Variáveis de método |
| 160 | +Variáveis locais devem ser *camelcase* iniciando em minúsculo. |
| 161 | + |
| 162 | +Observar o espaçamento entre a declaração de variáveis e o inicio do método. |
| 163 | + |
| 164 | + |
| 165 | + |
| 166 | +#### Variáveis privadas |
| 167 | +A declaração de váriaveis privadas deve ocorrer sempre dentro dos modificadores de acesso. |
| 168 | + |
| 169 | +Devem começar sempre com "f" minúsculo, seguido por seu nome em *camelcase* com a inicial em maiúsculo. |
| 170 | + |
| 171 | + |
| 172 | + |
| 173 | +#### Propriedades |
| 174 | +Propriedades devem usar *camelcase* começando sempre com a inicial em maiúsculo. |
| 175 | + |
| 176 | +Devem ter exatamente o nome de sua variável privada e/ou metodo de acesso, eliminando apenas o prefixo (f, get, set). |
| 177 | + |
| 178 | + |
| 179 | + |
| 180 | +#### Métodos |
| 181 | +A declaração de métodos deve ocorrer sempre dentro dos modificadores de acesso. |
| 182 | + |
| 183 | +Métodos devem ser *camelcase* iniciando em minúsculo. |
| 184 | + |
| 185 | +Os parâmetros do método devem ser *camelcase* iniciando em minúsculo. |
| 186 | + |
| 187 | +Procurar, quando possível, usar prefixos *get*, *set*, *eh*, etc de acordo com a função do método e/ou seu retorno. |
| 188 | + |
| 189 | + |
| 190 | + |
| 191 | +#### Interfaces |
| 192 | +Interfaces devem começar sempre com a letra "I" (maiúsculo), seguido por seu nome em *camelcase* com a inicial em maiúsculo também. |
| 193 | + |
| 194 | + |
| 195 | + |
| 196 | +#### Classes |
| 197 | +Classes devem começar sempre com a letra "T" (maiúsculo), seguido por seu nome em *camelcase* com a inicial em maiúsculo também. |
| 198 | + |
| 199 | +Classes que não extendem nenhuma outra classes em específico devem extender *TInterfacedObject*. |
| 200 | + |
| 201 | + |
| 202 | + |
| 203 | +#### Chamada de métodos em múltiplas linhas |
| 204 | +Métodos com chamadas muito extensas devem ser chamados usando padrão de identação JSON. |
| 205 | + |
| 206 | + |
| 207 | + |
| 208 | + |
| 209 | +#### Uso de blocos *begin end* |
| 210 | +Estruturas que não se utilizam do bloco de abertura e fechamento de código, como *ifs* de uma linha, em um código muito extenso geralmente atrapalham na leitura do código para posteriores modificações. Por esse motivo **todas** as estruturas devem possuir o bloco de abertura e fechamento (*begin .. end*) |
| 211 | + |
| 212 | + |
| 213 | + |
| 214 | + |
| 215 | +#### Identação |
| 216 | +Modificadores de acesso devem ser declarados de forma a ficarem alinhados à declaração da classe. |
| 217 | + |
| 218 | +Declaração de métodos, propriedades, construtores/destrutores, bem como o *var* da declaração de variáveis, devem estar alinhados. |
| 219 | + |
| 220 | +Agrupar *procedures* e *functions* sem alterná-los. |
| 221 | + |
| 222 | +Separar declações de variáveis, métodos, construtores, destrutores e propriedades com uma linha em branco, bem como deixar uma linha em branco antes da declaração de modificador de acesso, ou fim do bloco, exceto no primeiro modificador após a declaração da classes. |
| 223 | + |
| 224 | + |
| 225 | + |
| 226 | +#### Um código bem padronizado é muito mais fácil de ler, mesmo por programadores que utilizam outras linguagens. |
| 227 | + |
| 228 | +<br /> |
| 229 | + |
| 230 | +## TODO <a name="todo"></a> |
| 231 | ++ Documentação |
| 232 | + - Imagem de Sitemap |
| 233 | + - Imagem de workgroup |
| 234 | + - Forma de Uso |
| 235 | + - Colocar algoritmos no TODO |
| 236 | + - Árvore do Projeto |
| 237 | + |
| 238 | ++ Estrutura básica do código |
| 239 | + - Interface *ISort* |
| 240 | + - Estruturação/Criação dos pacotes |
| 241 | + |
| 242 | +<br /> |
| 243 | + |
| 244 | +## Árvore do Projeto <a name="arvore"></a> |
| 245 | +``` |
| 246 | +Ordenacao |
| 247 | +├── app |
| 248 | +│ └── .gitkeep |
| 249 | +├── documentation |
| 250 | +│ └── images |
| 251 | +│ └── .gitkeep |
| 252 | +├── images |
| 253 | +│ └── .gitkeep |
| 254 | +├── modules |
| 255 | +│ └── .gitkeep |
| 256 | +├── output |
| 257 | +│ └── .gitkeep |
| 258 | +├── project |
| 259 | +│ └── .gitkeep |
| 260 | +├── src |
| 261 | +│ └── .gitkeep |
| 262 | +├── vendor |
| 263 | +│ └── .gitkeep |
| 264 | +├── .gitattributes |
| 265 | +├── .gitignore |
| 266 | +├── LICENSE |
| 267 | +└── README.md |
| 268 | +``` |
0 commit comments