1
resposta

Hora da prática: docstrings

1 - Crie uma docstring para a função exibir_nome_do_programa()

def exibir_nome_do_programa():
"""
Exibe o nome do programa na tela.

Esta função é responsável por mostrar ao usuário
o nome do sistema ou aplicação em execução.
"""

2 - Crie uma docstring para a função exibir_opcoes()

def exibir_opcoes():
"""
Exibe as opções disponíveis do menu ao usuário.

Esta função mostra na tela as ações que o usuário
pode escolher para interagir com o sistema.
"""

3 - Crie uma docstring para a função finalizar_app()

def finalizar_app():
"""
Finaliza a execução da aplicação.

Esta função encerra o programa de forma segura,
exibindo uma mensagem de despedida ao usuário,
quando necessário.
"""

4 - Crie uma docstring para a função opcao_invalida()

def opcao_invalida():
"""
Trata a seleção de uma opção inválida pelo usuário.

Esta função exibe uma mensagem de erro informando
que a opção escolhida não é válida e orienta o
usuário a tentar novamente.
"""

5 - Crie uma docstring para a função exibir_subtitulo(texto)

def exibir_subtitulo(texto):
"""
Exibe um subtítulo formatado na tela.

Parâmetros:
texto (str): Texto que será exibido como subtítulo.
"""

6 - Crie uma docstring para a função cadastrar_novo_restaurante()

def cadastrar_novo_restaurante():
"""
Realiza o cadastro de um novo restaurante no sistema.

Esta função solicita os dados necessários ao usuário
e armazena as informações do restaurante para uso
posterior na aplicação.
"""

7 - Crie uma docstring para a função listar_restaurantes()

def listar_restaurantes():
"""
Exibe a lista de restaurantes cadastrados no sistema.

Esta função percorre os restaurantes registrados
e mostra suas informações ao usuário de forma organizada.
"""

8 - Crie uma docstring para a função alternar_estado_restaurante()

def alternar_estado_restaurante():
"""
Alternar o estado de funcionamento de um restaurante.

Esta função altera o status do restaurante entre
ativo e inativo (ou aberto e fechado), conforme
a seleção realizada pelo usuário.
"""

9 - Crie uma docstring para a função escolher_opcao()

def escolher_opcao():
"""
Processa a opção escolhida pelo usuário no menu.

Esta função lê a entrada do usuário, identifica
a opção selecionada e chama a funcionalidade
correspondente do sistema.
"""

10 - Crie uma docstring para a função main()

def main():
"""
Função principal da aplicação.

Esta função inicializa o programa, exibe o menu
principal e controla o fluxo de execução,
chamando as demais funções conforme a interação
do usuário.
"""
1 resposta

Olá, Luiz Henrique! Tudo bem?

Mandou muito bem na resolução dos exercícios!

Suas docstrings ficaram ótimas: claras, objetivas e descritivas. Gostei especialmente de ver o cuidado na função exibir_subtitulo, onde você especificou o parâmetro texto.

Criar o hábito de documentar o código desde o início é um grande diferencial. Isso ajuda muito não só outras pessoas que lerem seu código, mas também você mesmo no futuro.

Continue com esse empenho!

Bons estudos!

Sucesso

Imagem da comunidade