Beginner FriendlyFoundry
100 EXP
View results
Submission Details
Severity: low
Invalid

Non-Compliance with NatSpec Comments

Description

The contract does not adhere to the NatSpec commenting standard, which is the recommended commenting standard for Solidity smart contracts. NatSpec comments facilitate the automatic generation of function documentation and can improve the readability and maintainability of the code.

Impact

This issue is categorized as Informational due to the following impacts:

  • Lack of adherence to the NatSpec commenting standard may hinder automatic documentation generation.

  • It may also affect other developers' readability and understanding of the code.

Recommended Mitigation

It's advisable to adhere to the NatSpec commenting standard when writing comments in Solidity code. This would involve updating the existing comments to follow the NatSpec format.

Updates

Lead Judging Commences

inallhonesty Lead Judge
almost 2 years ago
inallhonesty Lead Judge almost 2 years ago
Submission Judgement Published
Invalidated
Reason: Non-acceptable severity

Support

FAQs

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