Skip to content

Instantly share code, notes, and snippets.

@rya-sge

rya-sge/awesome-solidity-doc-tools.md

Last active June 25, 2024 13:00
Show Gist options
  • Save rya-sge/f22d9fbf4b4f4cd01d7ee3cff6cb6ae5 to your computer and use it in GitHub Desktop.
Save rya-sge/f22d9fbf4b4f4cd01d7ee3cff6cb6ae5 to your computer and use it in GitHub Desktop.
Download ZIP
awesome-solidity-doc-tools
Raw
awesome-solidity-doc-tools.md

Awesome solidity doc tools

There are a lot of tools to create an excellent documentation for your Solidity Smart Contracts.

Here a quick list:

  • Slither to perform a static analysis on the smart contract and generate a vulnerability report.
  • Solidity-docgen: extract the documentation
  • Surya : generate graph, inheritance, markdown report, ...
  • Solgraph: generates a DOT graph that visualizes function control flow of a Solidity contract and highlights potential security vulnerabilities.
  • Sol2uml: generate an UML/Class diagram
  • vscode-solidity-auditor: Visual Studio Code extension contributing security centric syntax and semantic highlighting, a detailed class outline, specialized views, advanced Solidity code insights and augmentation to Visual Studio Code.

More details are available on my article: Tools to create documentation for Solidity Smart Contracts

Here some supplementary resources: awesome-smart-contract-analysis-tools Public

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment