Numpy Docstring
Como já sabemos como escrever os comentários de multilina, podemos usar as citações únicas triplas ou citações 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 oferecem documentação apenas pairando sobre o nome e alguns destacam certas palavras -chave. Mas o fato é que os documentos em Numpy são muito mais flexíveis do que em outros idiomas. Docstring é um literal de corda que ocorre no início da definição da função. Temos que fornecer valores específicos enquanto usamos os documentos em casos de funções, aulas, etc.
Ao usar o DocStrings com funções, temos que passar nos argumentos. Ao usá -los com aulas, 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 do docstring é, como explica o nome, que ajuda na documentação do nosso código. Fazemos documentação para que, se alguém usar nosso código no futuro, ele poderá entender nosso código e a lógica por trás do nosso código com a ajuda do Docstring. As funções embutidas também têm documentos; Podemos usar a função de ajuda () para analisar o documento de funções internas.
Existem algumas diferenças entre comentários e documentos. Os comentários são ignorados por intérpretes, mas os doces não são ignorados por intérpretes. A memória é alocada para o DocStrings. Um comentário é uma descrição do código, mas, por outro lado, o DocStrings nos diz o objetivo do código.
Sintaxe:
A sintaxe para escrever os documentos em Numpy é:
"" Mensagem de documentos "" "Ou
"Mensagem de Docstring"
Observe que o docstring não é uma função ou método, portanto não possui sintaxe adequada. A única coisa a observar aqui é que começamos o Docstring com três citações únicas ou três citações duplas. Escrevemos nossa descrição do código e terminamos novamente com três citações únicas ou três citações duplas no final. Não há coisa obrigatória para escrever para Docstrings. Você só precisa colocar três citações simples ou duplas antes e depois da descrição da sua string.
Exemplo 1:
Para entender os documentos de uma maneira melhor, vamos realizar um exemplo. Neste exemplo, depois de incluir a biblioteca Numpy, simplesmente declaramos a variável "A" e outra variável "B". Depois disso, criamos nossa documentação que diz “vamos adicionar“ A ”e“ B ”variáveis”. 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, resumimos as variáveis "A" e "B" e armazenamos sua saída resulta em outra variável que é "C". Finalmente, imprimimos o valor da variável "C". Agora, executamos nosso código.
importar numpy como npa = 1
b = 2
"Vamos adicionar variáveis A e B"
C = A+B
impressão (c)
Esta é a nossa saída da parte do código dado. Podemos ver que o sistema não deu nenhum erro sobre sintaxe incorreta ou qualquer coisa para a linha7 do nosso código. Além disso, o sistema não imprimiu nosso Docstring. Em vez disso, ele apenas imprimiu a saída de nossa variável "C", na qual dissemos ao nosso sistema para imprimir. Isso mostra como os documentos funcionam. Da próxima vez, quando um novo codificador tenta trabalhar em nosso código, ele entenderá o que estamos fazendo com a ajuda de nosso Docstring. Mas não será impresso como saída para que o usuário do código não seja perturbado por ele.
Exemplo 2:
Agora, realizamos um exemplo complexo para entender o trabalho do documento. Primeiro, incluímos a biblioteca Numpy e depois escrevemos uma sequência de documentos na qual explicamos a próxima linha de código em que explicamos a inicialização da matriz. Também adicionamos os documentos na outra parte do código. Agora, se compartilharmos esse código com qualquer novo desenvolvedor do Python sem adicionar os Docstrings, será de alguma forma difícil para ele conhecer o trabalho e o objetivo deste código. Ele tem que procurar primeiro sobre as funções que usamos. Mas se adicionarmos um documento ao nosso código, será fácil para os outros desenvolvedores entender 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 de uma linha. Também pode ser adicionado mais de uma vez em um código. Então, importe Numpy como NP.
"Criando a variável para a qual passaremos uma matriz de tamanho 1x6"Array = np.Array ([11, 22, 33, 44, 55, 66])
"Atribuindo a matriz à função Tofile () para deixá -lo salvo no arquivo chamado arr"
variedade.tofile ("arrum.bin ")
"Exiba o arquivo usando a função do arquivo"
Imprimir (NP.Fromfile ("ARR.bin ", dtype = int))
Conforme mostrado no snippet seguinte, o DocStrings não é exibido na saída, o que significa que ele não afeta a saída ou a compilação do código. Docstrings são ignorados durante o processo de compilação.
Conclusão
Neste guia, aprendemos sobre Docstrings em Numpy. Comparamos os documentos com comentários e explicamos a diferença entre os dois. Aprendemos a sintaxe do DocStrings e como escrever os Docstrings em nosso código. Além disso, também tentamos explicar o que são os documentos em Numpy e como eles trabalham com a ajuda de exemplos. Finalmente, observamos que eles são essenciais para os codificadores. Não vamos repetir a importância dos Docstrings em Numpy. Vamos apenas dizer que você deve usar os documentos em seu código. Em Numpy, o estilo de escrita dos documentos é o mais popular. É amplamente utilizado na comunidade de programação para informar um ao outro sobre o trabalho e a funcionalidade de seus códigos. Este guia ajudará você a começar com o Numpy Docstrings. Tentamos cobrir a maior parte do que você precisará usar o DocStrings em Numpy.