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.

Antes do algoritmo

Explique:

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:

Evite grandes blocos

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

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.

Exemplo

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

[EQUAÇÃO]

em que:

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

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