documentation solidity-doc?

Fred Douglis

documentation solidity-doc?


Je vois quelque chose que je suppose être semblable à javadoc sur https://www.npmjs.com/package/solidity-doc et Github sur https://github.com/vitiko/solidity-doc . Cependant, je ne vois aucune documentation … le plus proche que j’obtiens est une ligne dans Github mentionnant la /// notation .

Quelqu’un peut-il me dire où cela, ou quelque chose de similaire, peut être documenté? D’un rapide coup d’œil au code, je ne trouve pas les informations pertinentes.


Fred Douglis

@RichardHorrocks, merci, c’est ce que je cherchais. N’hésitez pas à poster une réponse. Devrait être dans la FAQ, mais je ne l’ai pas vu ….

Réponses


 Richard Horrocks

Ce que vous voulez, c’est Natspec .

Si vous voulez le convertir en un format plus agréable, jetez un œil à  » Convertir natspec en document lisible par l’homme « .

Fred Douglis

Hmm, j’ai installé doxity et essayé de construire, sans avoir encore de commentaires Natspec en place. Mais j’ai frappé un tas d’erreurs qui ressemblent plus à du bitrot (des chemins ne sont pas créés, ce genre de chose). Analysez également les erreurs. Je me demande si cela suit le rythme de Solidity …

Richard Horrocks

C’est ennuyeux. Correspond-il à l’un des problèmes les plus récemment signalés? github.com/DigixGlobal/doxity/issues ( Cela pourrait valoir la peine d’en augmenter un sinon, bien que le dernier commit ait eu lieu il y a 6 mois, donc bitrot ne serait pas surprenant …)

Fred Douglis

Malheureusement, les erreurs ne sont pas du tout informatives:> ⚠️ Contrat d’analyse d’erreur: AbortTest> ⚠️ Contrat d’analyse d’erreur: Commun> ⚠️ Contrat d’analyse d’erreur: Debuggable> ⚠️ Contrat d’analyse d’erreur: Econsent> ⚠️ Contrat d’analyse d’erreur: Enregistreur> ⚠️ Contrat d’analyse d’erreur: Migrations> ⚠️ Erreur d’analyse du contrat: ThrowProxy> ⚠️ Erreur d’analyse du contrat: chaînes> Génération de la sortie pour 8 contrats … terminé!

Fred Douglis

Voilà pour obéir aux sauts de ligne :). Quoi qu’il en soit, le problème est peut-être que ces interfaces utilisent des interfaces, et je vois des problèmes concernant le fait que solc ultérieur ne soit pas pris en charge. Cependant, il est toujours utile de mettre les balises @ et d’être prêt pour la doxité si cela fonctionne, et la source est au moins documentée de cette façon.

Fred Douglis

Je n’avais aucune idée si, après m’être plaint de l’analyse, je pouvais publier. Si je lance la publication, je reçois deux plaintes. L’une concerne une construction node.js manquante. Je n’en ai pas besoin pour mes trucs Solidity (pas encore de toute façon); Je m’attendrais à ce que doxity en fournisse un vide s’il en a besoin. L’autre tente de renommer scripts / doxity / public en docs .

 

documentation, solidity-doc?

 

yahoo

Laisser un commentaire

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