Cuando usamos una biblioteca integrada en un contrato inteligente de solidez, ¿por qué necesitamos usar @devuna @titleanotación?
Mi código es como a continuación:
/**
*@title SafeMath
*@dev Math operations with safety checks that throw on error
*/
library SafeMath {
/**
*@dev Multiplies two numbers, throws on overflow.
*/
function mul(uint256 a, uint256 b) internal pure returns (uint256) {
if (a == 0) {
return 0;
}
Consulte el formato github de Solidity Natural Specification (NatSpec) para obtener más información.
Los contratos de solidez pueden tener una forma especial de comentarios que forman la base del formato de especificación natural de Ethereum. Para ver un ejemplo de uso, consulte aquí .
Cuando usamos la biblioteca integrada en el contrato inteligente de solidez, ¿por qué necesitamos usar la anotación @dev y @title?
Para generar documentación como otros lenguajes de programación. Los analizadores de documentación leerán las anotaciones y generarán los archivos html y CSS correspondientes. Recomendaré escribir documentación para bibliotecas y contratos porque eso ayudará a otro desarrollador a comprender los métodos y su funcionalidad, en lugar de saltar al código.