¿Documentación solidity-doc?

Veo algo que supongo que es similar a javadoc en https://www.npmjs.com/package/solidity-doc y Github en https://github.com/vitiko/solidity-doc . Sin embargo, no veo documentación... lo más cercano que tengo es una línea en Github que menciona /// notation.

¿Alguien puede decirme dónde se puede documentar esto o algo similar? De un vistazo rápido al código, no encuentro la información relevante.

@RichardHorrocks, gracias, eso es lo que estaba buscando. Por favor, siéntase libre de publicar como respuesta. Debería estar en las preguntas frecuentes, pero no lo vi....

Respuestas (1)

Lo que quieres es Natspec .

Si desea convertir esto a un formato más agradable, eche un vistazo a " Convertir natspec en un documento legible por humanos ".

Hmm, instalé doxity e intenté compilar, sin tener aún los comentarios de Natspec en su lugar. Pero encontré un montón de errores que parecen más bitrot (no se crean rutas, ese tipo de cosas). Además, analice los errores. Me pregunto si se mantiene al ritmo de Solidity....
Eso es molesto. ¿Coincide con alguno de los problemas informados más recientemente? github.com/DigixGlobal/doxity/issues (Podría valer la pena plantear uno si no, aunque parece que el último compromiso fue hace 6 meses, por lo que bitrot no sería sorprendente...)
Desafortunadamente, los errores no son informativos en absoluto: >⚠️ Error al analizar el contrato: AbortTest >⚠️ Error al analizar el contrato: común >⚠️ Error al analizar el contrato: Depurable >⚠️ Error al analizar el contrato: Econsent >⚠️ Error al analizar el contrato: Registrador >⚠️ Error al analizar el contrato: Migraciones > ⚠️ Error al analizar el contrato: ThrowProxy >⚠️ Error al analizar el contrato: cadenas > Generando resultados para 8 contratos... ¡hecho!
Tanto por obedecer los saltos de línea :). De todos modos, es posible que el problema sea que estas usan interfaces, y veo problemas que hablan de que la solc posterior no es compatible. Sin embargo, aún es útil colocar las etiquetas @ y estar listo para la doxidad si alguna vez funciona, y la fuente al menos está documentada de esta manera.
No tenía idea de si, después de quejarme del análisis, podría publicar. Si ejecuto publicar, recibo dos quejas. Uno es sobre una compilación de node.js que falta. No lo necesito para mis cosas de Solidity (todavía no de todos modos); Esperaría que doxity proporcione uno vacío si lo necesita. El otro está tratando de cambiar el nombre de scripts/doxity/public a docs .
NB: agregar una entrada de compilación de marcador de posición en package.json solucionó la única queja, y agregar una ruta a público hizo que cambiara de un error a copiar un directorio vacío. Pero todavía no tengo documentación. Y el archivo Léame y demás no dicen nada sobre las opciones de depuración por lo que puedo ver. Dado que han tenido problemas abiertos sobre las interfaces y demás durante algún tiempo, tengo la sensación de que ya no es compatible y que no vale la pena continuar...
¿Documentación solidity-doc?
RespuestasAquíPolítica de privacidad1y, 0v