2
respostas

[Projeto] Minha solução a doc string

def main():
    '''
    Todo o nosso programa está aqui, ele se inicia no main e executa todas as demais funções que correspondem aos passos que o programa faz
    
    '''

def escolher_opcao():
    '''
    Corpo de controle do nosso programa, o nosso menu de opções
    '''

def alternar_estado_restaurante():
    '''
    Nessa função você pode alterar o status de ativo ou inativo de um restaurante
    '''

def listar_restaurantes():
    '''
    Essa função ela lista todos os restaurantes que criamos em nossa programa
    '''

def cadastrar_novo_restaurante():
    '''
    Para cadastrar um novo restaurante 

    input recebe as informações
    e é tudo armazenado dentro de um dicionário que tem dados como nome, categoria e status ativo ou inativo
    '''

def exibir_subtitulo(texto):
    '''
    Nesse campo é só como os subtítulos são exibidos no nosso programa
    '''

def opcao_invalida():
    '''
    Caso alguma informação inserida pelo usuário seja inválida, esse campo lida com os erros cometidos de digitação
    '''

def voltar_ao_menu_principal():
    '''
    Função destinada ao retorno do menu de opções do programa
    '''


def finalizar_app():
    '''
    Essa função é destinada ao encerramento do aplicativo, quando o usuário desejar encerrar o aplicativo
    '''


def exibir_opcoes():
    '''
    o  programa ele é composto por opções, então cada opção executa uma ação em nosso programa. 
    '''

def exibir_nome_do_programa():
   '''
   Dentro dessa função é exibido o nome do nosso programa.
   '''

2 respostas

Oi, Juan! Como vai?

Agradeço por compartilhar.

Gostei da sua organização das docstrings, do jeito que você explicou o papel de cada função e como elas se conectam ao fluxo do programa, isso mostra clareza de raciocínio e cuidado com a leitura do código.

Como incentivo, continue praticando essa descrição intencional das funções, pois ela facilita manutenção e colaboração.
Dica: descreva sempre o que a função faz e como ela impacta o programa, usando frases curtas e objetivas logo na primeira linha da docstring.

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

Olá Lorena como vai?

Muito obrigado pelo seu feedback, irei seguir suas dicas, acredito que vai facilitar demais a leitura e o entendimento do código.

Atenciosamente

Juan