Guia rápido para comentários de solidez
Neste artigo, exploraremos a importância dos comentários do Solidity , os tipos de comentários que podem ser usados e as práticas recomendadas para comentar seu código de maneira eficaz.
Os comentários no Solidity são uma parte essencial de qualquer base de código, incluindo contratos inteligentes.
Eles são usados para documentar o código, explicar como ele funciona e fornecer contexto para outros desenvolvedores que possam estar trabalhando na mesma base de código.
Seja você novo no Solidity ou um desenvolvedor experiente, este artigo fornecerá informações valiosas sobre o papel dos comentários na redação de contratos inteligentes seguros e eficientes .
Comentários de solidez
Os comentários de solidity são semelhantes aos comentários de estilo C e C++ e ambos são suportados.
Solidity suporta dois tipos de comentários:
Comentários de linha única
Uma linha que começa com // é tratada pelo Solidity Compiler como um comentário de linha única e é ignorada durante sua execução.
Comentários de várias linhas
Os comentários de várias linhas começam com uma barra seguida por um asterisco /* e terminam com um asterisco seguido por uma barra */ .
O texto entre /* e */ é considerado um comentário de várias linhas.
Aqui está um exemplo de como os comentários podem ser usados no solidity:
Example:
Exemplo de Explicação
No exemplo acima, definimos uma variável string mrx e uma função getString para recuperar seu valor.
A solidez do pragma da linha ^0.5.13; especifica a versão do compilador Solidity a ser usada para este contrato.
O símbolo ^ significa que o contrato pode ser compilado com qualquer versão do Solidity de 0.5.13 até, mas não incluindo, a versão 0.6.
O contrato My_Contract tem uma função construtora que define o valor inicial de mrx como “ Mr.Examples ” quando o contrato é implantado.
A função constructor() é uma função especial que é chamada apenas uma vez quando o contrato é implantado no blockchain.
A função getString() é uma função de exibição publicamente acessível, o que significa que pode ser chamada de fora do contrato e não modifica o estado do contrato. Ele retorna o valor da variável mrx.
Os comentários no código explicam como usar comentários de linha única e multilinha no Solidity.
Example:
Exemplo de Explicação
Neste exemplo, definimos um contrato chamado SolidityTest e uma função chamada getValue.
O contrato HelloWorld tem duas variáveis inteiras chamadas mrx e ample, que são inicializadas no construtor.
Esta linha é um comentário que indica a licença de software do contrato. Neste caso, é a GNU General Public License v3.0.
pragma solidity ^0.8.0;
Esta linha especifica a versão do compilador Solidity que deve ser usada para compilar o contrato. O símbolo ^ significa que o contrato é compatível com qualquer versão do compilador Solidity de 0.8.0 até, mas não incluindo, 0.9.0.
contract SolidityTest{
// The code is written in this
}
Esta é a definição do contrato. Ele define um novo contrato chamado SolidityTest.
uint mrx; uint ample;
Essas duas linhas definem duas variáveis inteiras sem sinal mrx e ample no contrato SolidityTest.
constructor() {
mrx = 2;
ample = 4;
}
Esta é a função construtora que inicializa os valores de mrx e ample para 2 e 4, respectivamente.
function getValue() public view returns (uint sum) {
return ample+mrx;
}
Acima está uma função getValue que calcula a soma de ample e mrx. Está marcado como public, o que significa que pode ser chamado por qualquer pessoa, e view, o que significa que não modifica o estado do contrato. A função retorna a soma de ample e mrx como um inteiro sem sinal.
Comentário de solidez /* A soma de Ample e Mrx será: 2 + 4 = 6 */ é apenas uma descrição legível por humanos do que a função faz. Não é usado pelo compilador ou pela Ethereum Virtual Machine (EVM) de forma alguma.
Em conclusão , os comentários do Solidity são um recurso essencial para os desenvolvedores documentarem e explicarem seu código. Eles podem ajudar a tornar o código mais legível e compreensível para outros desenvolvedores e futuros mantenedores.
Os comentários de solidez podem ser usados para descrever funções, variáveis e características do contrato, bem como para fornecer informações sobre a arquitetura geral do projeto e as decisões de design.
