# CAPÍTULO 4 — ALGORITMOS, CÓDIGOS E EQUAÇÕES

# PÁGINA 4.1 — Algoritmos

Um algoritmo deve ser apresentado quando a lógica de um procedimento é relevante para compreender ou reproduzir o trabalho.

Assim como qualquer elemento visual:

> **Todo algoritmo deve ser mencionado e explicado no texto.**

Não insira um algoritmo sem contextualização.

<div contenteditable="false" id="bkmrk-">---

</div>## Antes do algoritmo

Explique:

- objetivo;
- entradas;
- saída;
- contexto de utilização.

<div contenteditable="false" id="bkmrk--1">---

</div>## Depois

Explique os passos relevantes, principalmente decisões, laços ou condições importantes.

Não é necessário traduzir linha por linha se o algoritmo for autoexplicativo.

# PÁGINA 4.2 — Código-fonte

Trechos de código devem ser utilizados com parcimônia.

O TCC não deve funcionar como documentação completa da implementação.

Inclua código quando ele for necessário para:

- demonstrar uma técnica;
- explicar uma configuração relevante;
- apresentar uma implementação essencial;
- apoiar a reprodutibilidade.

<div contenteditable="false" id="bkmrk-">---

</div>## Evite grandes blocos

Se dezenas ou centenas de linhas forem necessárias, considere disponibilizá-las como:

- apêndice;
- repositório;
- artefato complementar.

No texto principal, apresente apenas o trecho necessário para a discussão.

# PÁGINA 4.3 — Equações

Toda equação relevante deve ser explicada.

Ao apresentar uma equação:

1. introduza sua finalidade;
2. apresente a equação;
3. defina todas as variáveis;
4. informe unidades quando aplicável;
5. explique como ela será utilizada.

<div contenteditable="false" id="bkmrk-">---

</div>## Exemplo

> A precisão é calculada conforme a Equação X:

**<span class="text-token-text-primary cursor-text rounded-sm" data-placeholder-token="true">\[EQUAÇÃO\]</span>**

em que:

- TP representa verdadeiros positivos;
- FP representa falsos positivos.

Depois, explique a importância da métrica para o trabalho.

<div contenteditable="false" id="bkmrk--1">---

</div>## Não suponha que símbolos são óbvios

Mesmo símbolos comuns podem assumir significados diferentes em contextos distintos.

Defina-os.

# PÁGINA 4.4 — Checklist

- <span class="task-list-item-checkbox" contenteditable="false"> [ ] </span>Todo algoritmo foi mencionado no texto.
- <span class="task-list-item-checkbox" contenteditable="false"> [ ] </span>A função do algoritmo foi explicada.
- <span class="task-list-item-checkbox" contenteditable="false"> [ ] </span>Entradas e saídas estão claras.
- <span class="task-list-item-checkbox" contenteditable="false"> [ ] </span>Trechos de código são realmente necessários.
- <span class="task-list-item-checkbox" contenteditable="false"> [ ] </span>Código extenso foi movido para local apropriado.
- <span class="task-list-item-checkbox" contenteditable="false"> [ ] </span>Toda equação foi introduzida.
- <span class="task-list-item-checkbox" contenteditable="false"> [ ] </span>Todas as variáveis foram definidas.
- <span class="task-list-item-checkbox" contenteditable="false"> [ ] </span>Unidades estão indicadas quando aplicável.
- <span class="task-list-item-checkbox" contenteditable="false"> [ ] </span>Está claro como cada equação é utilizada no trabalho.