From 67c14bd3a8d0f8c32cf91fcd522b34409444e51a Mon Sep 17 00:00:00 2001 From: aniket-engg Date: Mon, 27 Apr 2020 10:52:29 +0530 Subject: [PATCH] static analysis doc updated --- docs/static_analysis.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/docs/static_analysis.md b/docs/static_analysis.md index ac3de2ed7e..5869215329 100644 --- a/docs/static_analysis.md +++ b/docs/static_analysis.md @@ -1,14 +1,26 @@ -Analysis -======== +Solidity Static Analysis +======================== -This section gives information about the last compilation. By default, a -new analysis is run at each compilation. +Static code analysis is a process to debug the code by examining it and without actually executing the code. -The analysis tab gives detailed information about the contract code. It -can help you avoid code mistakes and to enforce best practices. +`Solidity Static Analysis` plugin performs static analysis on Solidity smart contracts once they are compiled. It helps to check security vulnerabilities and bad development practices. This plugin comes with `Solidity` environment of Remix IDE. It can also be activated individually from `Plugin Manager`. + +How to use +------------ + +If you select this plugin, you will see a number of modules listed along with checkboxes, one `Auto run` checkbox and a `Run` button. ![](images/a-static-analysis.png) +By default, all modules are selected for analysis and a new analysis is performed at each compilation. + +One can select the modules under which contract should be analyzed and can run the analysis again for last compiled contract by clicking on `Run`. + +If you don't want to run analysis each time you compile a contract, just uncheck the checkbox near to `Auto run`. + +Analysis Modules +----------------- + Here is the list of analyzers: Security: