LÓGICA E LINGUAGEM DE PROGRAMAÇÃO

Boas práticas de nomeação

Registro de Aula S13A3 — Semana 13 · Aula 3 – Nomes semânticos, funções com e sem retorno
Unidade 2 – Funções e modularizaçãoBase: Capítulos 32 a 35 — por que usar funções, criar funções, parâmetros e returnTempo: 45 a 50 minEntrega: AVA (relato + arquivo .py)Arquivo: NOME_TURMA_S13A3
ATIVIDADE PROPOSTA

O que vocês vão resolver

Vocês fazem parte de uma equipe que montou um pequeno sistema para organizar as tarefas de uma turma. O programa funciona — o problema é outro: as funções têm nomes genéricos como f1, coisa e calc, e a cada correção a equipe perde tempo tentando descobrir o que cada uma faz. O desafio é melhorar a clareza do código com boas práticas de nomeação e organizar a lógica em funções com e sem retorno.

OBJETIVOS

O que vocês vão aprender aqui

SOLUÇÃO DIGITAL

Ferramenta usada nesta aula

PY
Python (Google Colab ou IDE do laboratório)
O programa final precisa ser salvo como um arquivo .py e enviado junto com o relato. No Colab, use Arquivo → Fazer download → .py. O relatório desta página é preenchido aqui e exportado em PDF pelo navegador.
https://colab.research.google.com/
ENTENDA

De nome genérico a nome que explica

Um bom nome de função responde sozinho “o que isso faz?”. A regra prática é simples: <b>verbo + objeto</b>, em snake_case, sem abreviações que só quem escreveu entende.

O código de partida (propositalmente ruim)tarefas = ["estudar", "treinar", "entregar trabalho"] def f1(x):for i in x:print(i) def coisa(x):return len(x) def calc(x):if len(x) == 0: return "vazio"return x[0]Rode este código primeiro: ele funciona. O problema não é o resultado — é ninguém conseguir ler.
As três regras de nomeação1. VERBO + OBJETOexibir_tarefas, contar_tarefas, obter_primeira_tarefa 2. NADA de nome genéricof1, coisa, calc, processa, dados, x 3. snake_casetudo minúsculo, palavras separadas por _Vale para variáveis também: x e i viram lista_tarefas e tarefa.
Sem retorno Procedimento só executa uma ação — ex.:exibir_tarefas() imprime epronto Com retorno Devolve um valor quem chamou usa o resultado —ex.: contar_tarefas() devolveum número Regra prática: função que só mostra algo na tela geralmente não precisa retornar nada.

Como preencher este relatório

  1. 1Leia o cenário e observe os diagramas — eles mostram o conceito que a sua resposta precisa usar.
  2. 2Preencha a identificação do grupo no Passo 0.
  3. 3Responda um passo de cada vez, na ordem. Cada passo traz uma dica de como pensar logo abaixo do enunciado.
  4. 4Confira o checklist no final — ele verifica se não ficou nada faltando.
  5. 5Clique em Gerar PDF da resposta. Na janela de impressão, escolha Destino: Salvar como PDF e salve como NOME_TURMA_S13A3.
  6. 6Envie esse PDF no AVA. O que vocês digitarem fica salvo neste computador sozinho — dá para fechar a página e voltar depois.
PASSO 0

Identificação

Estes dados montam a capa e a folha de rosto do relatório em PDF.

PROCEDIMENTOS

Refatorem o programa

A ordem importa: primeiro entender o que o código faz, depois renomear, e só então reorganizar e testar.

1
Executem o código de partida e escrevam o que cada função faz hoje.
Como pensar: Rodem antes de mexer em qualquer coisa. Escrevam a explicação como se fosse um comentário no código — é o primeiro passo do roteiro.
2
Renomeiem as três funções e justifiquem cada nome.
Como pensar: Use verbo + objeto em snake_case. O teste do bom nome: alguém que nunca viu o código consegue dizer o que a função faz só pelo nome?
Nome atualNome novoPor que esse nome
f1
coisa
calc
3
Classifiquem cada função: tem retorno ou não?
Como pensar: O roteiro exige pelo menos uma de cada tipo. Repare que a função que só imprime não precisa devolver nada — quem chama já viu o resultado na tela.
Função (nome novo)Tem retorno?O que devolve (ou por que não devolve)
1ª função
2ª função
3ª função
4
Melhorem também os nomes das variáveis.
Como pensar: Os parâmetros x e o item do laço i não dizem nada. O que eles representam de verdade neste programa?
5
Reorganizem o programa e colem a versão final.
Como pensar: A ordem pedida é: mostrar a lista, depois a quantidade, depois a primeira tarefa. O programa principal deve ficar “limpo” — só chamadas de função, sem lógica solta.
def exibir_tarefas(lista_tarefas): ... def contar_tarefas(lista_tarefas): ... def obter_primeira_tarefa(lista_tarefas): ... # programa principal — só chamadas tarefas = ["estudar", "treinar", "entregar trabalho"] ...
6
Testem com lista cheia e com lista vazia.
Como pensar: O segundo teste é o que importa: com tarefas = [], o programa ainda funciona? A função que pega a primeira tarefa precisa tratar esse caso.
Caso de testeSaída obtidaFuncionou sem erro?
Lista cheia — ["estudar", "treinar", "entregar trabalho"]
Lista vazia — []
7
Confirmem a entrega do arquivo .py.
Como pensar: O programa final precisa ir para o AVA como arquivo .py, além deste relatório. No Colab: Arquivo → Fazer download → .py
8
Escrevam o relato final (12 a 18 linhas).
Como pensar: O roteiro pede cinco pontos: por que os novos nomes são melhores; que critérios vocês usaram para escolher; como isso melhora leitura e manutenção; como aumenta a coesão e a clareza; e como funções com e sem retorno ajudam a modularizar.
CONFIRA

Checklist antes de gerar o PDF

Ao clicar em “Gerar PDF da resposta”, o navegador monta o relatório completo no padrão de roteiro de aula prática — com capa, folha de rosto, objetivos, procedimentos, as respostas do grupo e as referências. Na janela de impressão, escolha Destino: Salvar como PDF, salve como NOME_TURMA_S13A3 e envie no AVA.
AVALIAÇÃO

Como esta atividade será avaliada

CritérioPontos
Nomes semânticos e padrão snake_case aplicados a funções e variáveis3,0
Pelo menos uma função com retorno e uma sem retorno, bem escolhidas2,0
Programa reorganizado, principal limpo e funcionando nos dois testes3,0
Relato explicando critérios, manutenção e modularização2,0
REFERÊNCIAS

De onde veio o conteúdo desta aula

Curso Técnico em Desenvolvimento de Sistemas
Roteiro de Aula Prática
Lógica e Linguagem de Programação
Boas práticas de nomeação
São Paulo - SP
2026
Roteiro de Aula Prática
Boas práticas de nomeação
Roteiro de Aula Prática apresentado ao componente curricular Lógica e Linguagem de Programação, como requisito parcial de avaliação do 2º bimestre.
São Paulo - SP
2026

Roteiro de Aula Prática

Nome da disciplina: LÓGICA E LINGUAGEM DE PROGRAMAÇÃO
Unidade: 2 – Funções e modularização
Aula: 3 – Nomes semânticos, funções com e sem retorno
Base teórica: Capítulos 32 a 35 — por que usar funções, criar funções, parâmetros e return

Objetivos

  • Aplicar boas práticas de nomeação, criando funções com nomes claros e semânticos.
  • Desenvolver um programa modular em Python com pelo menos uma função com retorno e uma sem retorno.
  • Melhorar a coesão e a clareza do código, deixando o programa principal enxuto.
  • Justificar como os nomes escolhidos facilitam a leitura, a colaboração e a manutenção.

Solução digital

Python (Google Colab ou IDE do laboratório)

LINK SOLUÇÃO DIGITAL: https://colab.research.google.com/

O programa final precisa ser salvo como um arquivo .py e enviado junto com o relato. No Colab, use Arquivo → Fazer download → .py. O relatório desta página é preenchido aqui e exportado em PDF pelo navegador.

Procedimento / Atividade

Atividade proposta: Vocês fazem parte de uma equipe que montou um pequeno sistema para organizar as tarefas de uma turma. O programa funciona — o problema é outro: as funções têm nomes genéricos como f1, coisa e calc, e a cada correção a equipe perde tempo tentando descobrir o que cada uma faz. O desafio é melhorar a clareza do código com boas práticas de nomeação e organizar a lógica em funções com e sem retorno.

Procedimentos para a realização da atividade

Checklist de entrega

Critérios de avaliação

CritérioPontos
Nomes semânticos e padrão snake_case aplicados a funções e variáveis3,0
Pelo menos uma função com retorno e uma sem retorno, bem escolhidas2,0
Programa reorganizado, principal limpo e funcionando nos dois testes3,0
Relato explicando critérios, manutenção e modularização2,0

Referências

  • SEDUC-SP — Roteiro de Atividade Prática SISANO1C1B2S13A3AP: “Boas práticas de nomeação”. Situação fictícia produzida pela SEDUC-SP.
  • Apostila da disciplina — Capítulos 32 a 35: por que utilizar funções, criando funções, parâmetros e return.
  • PEP 8 — Style Guide for Python Code: convenções de nomeação (snake_case para funções e variáveis).
  • MENEZES, N. N. C. Introdução à programação com Python. São Paulo: Novatec, 2024.
salva sozinho neste computador