1
resposta

Hora da prática: docstrings

def exibir_nome_do_programa():
    '''Essa funcao e responsavel por exibir o nome do programa'''
def exibir_opcoes():
    '''Essa funcao e responsavel por mostra as opcoes do menu '''
def finalizar_app():
    '''Esssa funcao e responsavel por finalizar o app'''
    exibir_subtitulo('Finalizando o app')
def voltar_ao_menu_principal():
    '''Essa funcao e responsavel por voltar o menu principal
        input:O usuario digita qualquer tecla para volta o menu principal
        output:exibi as opcoes para esolha do menu 
    '''
    input('\nDigite uma tecla para voltar ou menu ')
    main()
def opcao_invalida():
    '''Essa funcao e responsavel por mostra uma uma mensagem caso a opcao digita seja invalida
    output:retorna ao menu principal
    '''
def exibir_subtitulo(texto):
    '''Essa funcao e responsavel por mostra os subtitulos da funcoes e cria uma linha a cima e a baixo de *'''
def cadastrar_novo_restaurante():
    '''Essa funcao e responsavel por cadastrar um restaurante
    inputs:
    - Nome do restaurante
    - Categoria

    outputs:
    - Adiciona um novo restaurante a lista de restaurante 

    '''
def listar_restaurantes():
    '''Esssa e responsavel por listar os restaurantes
    inputs:
    - nome
    - categoria
    condicao: ativado/desativado
    output: exibi a lista com o nome a categoria e se esta ativado ou desativado
    '''
def alternar_estado_restaurante():
    '''Essa funcao e reponsavel por alterar o estado de um restaurante(desativado/ativado)'''
def escolher_opcao():
    '''Essa funcao e responsavel por armazenar a opcao escolhida do usuario'''
def main():
    '''Essa funcao exibi as funcoes q serao executadas em ordem de cima para baixo se o arquivo __name__ for igual a __main__)'''
1 resposta

Olá, Apollo! Como vai?

Parabéns pela resolução da atividade!

Observei que você explorou o docstrings para documentar as funções com Python, utilizou muito bem a organização modular para implementar o programa e ainda compreendeu a importância da clareza nos comentários para facilitar a manutenção do código.

Uma dica interessante para o futuro é aplicar a convenção de docstrings no formato PEP 257, que é o padrão oficial do Python. Isso faz com que a documentação fique mais padronizada e compatível com ferramentas de geração automática de documentação.

Alguns materiais podem estar em inglês, mas é possível compreendê-los usando o recurso de tradução de páginas do próprio navegador.

Fico à disposição! E se precisar, conte sempre com o apoio do fórum.

Abraço e bons estudos!

AluraConte com o apoio da comunidade Alura na sua jornada. Abraços e bons estudos!