@dev et @title solidity [duplicate]

PrashantNagawade

@dev et @title solidity [duplicate]


Cette question a déjà une réponse ici:

Lorsque nous utilisons une bibliothèque intégrée dans un contrat intelligent de solidité, pourquoi devons-nous utiliser l’annotation @dev et @title ?

Mon code est comme ci-dessous:

 /** *@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 ; 
         } 

Réponses


 TC8

Voir le github au format Solidity Natural Specification (NatSpec) pour plus de détails

Les contrats de solidarité peuvent avoir une forme spéciale de commentaires qui constitue la base du format de spécification naturelle Ethereum. Pour un exemple d’utilisation, veuillez vérifier ici .


 Jitendra Kumar. Balla

Lorsque nous utilisons une bibliothèque intégrée dans un contrat intelligent de solidité, pourquoi devons-nous utiliser l’annotation @dev et @title?

Pour générer de la documentation comme d’autres langages de programmation. L’analyseur de documentation lira les annotations et générera les fichiers CSS, html correspondants. Je recommanderai d’écrire de la documentation pour les bibliothèques et les contrats car cela aidera un autre développeur à comprendre les méthodes et ses fonctionnalités, au lieu de sauter dans le code.

 

[duplicate], @title, #et, dev, Solidity?

 

yahoo

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *