20,000 USDC
View results
Submission Details
Severity: gas
Valid

NatSpec Comments

Summary

Code functions and parts lacking rich NatSpec code commenting

Vulnerability Details

Staking.sol line 31 missing Natspec for constructor e.g @param _token, @param __weth
Lender.sol lines 11 - 56, all events are lacking NatSpec documentation
Fees.sol line 19 constructor lacking NatSpec e.g @param _weth, @param _staking
Beedle.sol completely lacks any NatSpec commenting

Impact

Informational: This impacts code quality, interpretability, readability, maintanability and auditability of code. It is important code follows style guide, best practises of documentation as prescribed in solidity documentation.

Tools Used

Manual Analysis

Recommendations

It is recommended that all functions, modifiers, events and other relevant aspects have rich NatSpec commenting detailing notes, params, return values etc

Support

FAQs

Can't find an answer? Chat with us on Discord, Twitter or Linkedin.