Foundry DeFi Stablecoin CodeHawks Audit Contest

Summary

There are code comments that must not be deployed with final code

Vulnerability Details

It is important to keep only necessary comments in the code. The comments on Layout must not make it to final code. Comments must also be short, descriptive, concise in order to not bloat the code.
Lines 2-22 all contract have example of such types of comments

Impact

Informational: Lots of unnecessary comment can add to bigger files to read for code, larger code files to deploy, readability and maintanability and auditability of code

Tools Used

Manual Analysis

Recommendations

It is important to remove all comments not useful for final deployed contracts, comments such as notes for own developing process, TODOs etc. It is important to shorten the comments in NatSpec to ensure they are as succinct as possible