Como já sabemos como escrever os comentários de várias linhas, podemos usar as aspas simples triplas ou aspas duplas triplas. Usamos uma string de documentação quando queremos descrever nossas funções para que possamos obter a documentação quando precisarmos. Alguns IDEs fornecem documentação apenas passando o mouse sobre o nome e alguns destacam determinadas palavras-chave. Mas o fato é que docstrings no NumPy são muito mais flexíveis do que em outras linguagens. Docstring é um literal de string que ocorre no início da definição da função. Temos que fornecer valores específicos ao usar as docstrings em casos de funções, classes, etc.
Ao usar docstrings com funções, temos que passar os argumentos. Ao usá-los com classes, passamos os atributos e métodos. No caso de Módulos, temos que fornecer uma lista de classes e funções. No caso do pacote, passamos a lista de módulos com funcionalidade. Então, basicamente, o objetivo da docstring é, como o nome explica, ajudar na documentação do nosso código. Fazemos documentação para que, se alguém usar nosso código no futuro, ele possa entender nosso código e a lógica por trás de nosso código com a ajuda de docstring. Funções internas também possuem docstrings; podemos usar a função help() para ver a docstring de funções internas.
Existem algumas diferenças entre comentários e docstrings. Os comentários são ignorados pelos intérpretes, mas as docstrings não são ignoradas pelos intérpretes. A memória é alocada para docstrings. Um comentário é uma descrição do código, mas, por outro lado, as docstrings nos dizem o propósito do código.
Sintaxe:
A sintaxe para escrever as docstrings no NumPy é:
'''Mensagem Docstring'''
Ou
'''Mensagem Docstring'''
Observe que docstring não é uma função ou método, portanto, não possui sintaxe adequada. A única coisa a notar aqui é que começamos a docstring com três aspas simples ou três aspas duplas. Escrevemos nossa descrição do código e terminamos novamente com três aspas simples ou três aspas duplas no final. Não há nada obrigatório para escrever para docstrings. Você só precisa colocar três aspas simples ou duplas antes e depois da descrição da string.
Exemplo 1:
Para entender melhor as docstrings, vamos fazer um exemplo. Neste exemplo, após incluir a biblioteca NumPy, simplesmente declaramos a variável “a” e outra variável “b”. Depois disso, criamos nossa docstring que diz “Vamos adicionar as variáveis “a” e “b””. No nosso caso, este é um exemplo fácil, mas se nosso código for complexo, isso ajuda muito o codificador a entender o código. Depois disso, somamos as variáveis “a” e “b” e armazenamos seu resultado de saída em outra variável que é “c”. Por fim, imprimimos o valor da variável “c”. Agora, executamos nosso código.
importar numpy Como por exemplo.uma = 1
b = dois
'''Vamos adicionar as variáveis a e b'''
c = a+b
imprimir ( c )
Esta é a nossa saída do trecho de código fornecido. Podemos ver que o sistema não deu nenhum erro sobre sintaxe incorreta ou qualquer coisa para a linha 7 do nosso código. Além disso, o sistema não imprimiu nossa docstring. Em vez disso, ele imprimiu apenas a saída de nossa variável “c” na qual dissemos ao nosso sistema para imprimir. Isso mostra como as docstrings funcionam. Da próxima vez, quando um novo codificador tentar trabalhar em nosso código, ele entenderá o que estamos fazendo com a ajuda de nossa docstring. Mas ele não será impresso como saída para que o usuário do código não seja incomodado por ele.
Exemplo 2:
Agora, realizamos um exemplo complexo para entender o funcionamento da docstring. Primeiro, incluímos a biblioteca NumPy e depois escrevemos uma string doc na qual explicamos a próxima linha de código onde explicamos a inicialização do array. Também adicionamos as docstrings na outra parte do código. Agora, se compartilharmos esse código com qualquer novo desenvolvedor Python sem adicionar as docstrings, de alguma forma será difícil para ele conhecer o funcionamento e o propósito desse código. Ele tem que pesquisar primeiro sobre as funções que usamos. Mas se adicionarmos uma docstring ao nosso código, será fácil para os outros desenvolvedores entenderem o código sem estudar mais sobre as funções. Não estamos restritos a adicionar comentários a alguns limites; os comentários podem ser de uma ou mais linhas. Também pode ser adicionado mais de uma vez em um código. Em seguida, importe NumPy como np.
'''Criando a variável para a qual passaremos um array de tamanho 1x6'''variedade = por exemplo. variedade ( [ onze , 22 , 33 , 44 , 55 , 66 ] )
'''atribuindo o array à função tofile() para deixá-lo salvo no arquivo chamado arr'''
variedade . arquivar ( 'arr.bin' )
'''exibe o arquivo usando a função fromfile'''
imprimir ( por exemplo. De arquivo ( 'arr.bin' , dtype = int ) )
Conforme mostrado no trecho a seguir, as docstrings não são exibidas na saída, o que significa que isso não afeta a saída ou a compilação do código. Docstrings são ignoradas durante o processo de compilação.
Conclusão
Neste guia, aprendemos sobre docstrings no NumPy. Comparamos as docstrings com comentários e explicamos a diferença entre ambos. Aprendemos a sintaxe das docstrings e como escrever as docstrings em nosso código. Além disso, também tentamos explicar o que são as docstrings no NumPy e como elas funcionam com a ajuda de exemplos. Por fim, observamos que eles são essenciais para os codificadores. Não repetiremos a importância das docstrings no NumPy. Diremos apenas que você deve usar as docstrings em seu código. No NumPy, o estilo de escrita de docstrings é o mais popular. É amplamente utilizado na comunidade de programação para informar uns aos outros sobre o funcionamento e a funcionalidade de seus códigos. Este guia irá ajudá-lo a começar com as docstrings NumPy. Tentamos cobrir a maior parte do que você precisará usando as docstrings no NumPy.