firmware-base/scripts/clean.md
2025-05-23 20:52:18 +02:00

16 lines
724 B
Markdown

# Context
- ESP-32, Platform.io, C17
- avoidance of std
- industrial application, using Modbus-485
# Todos
- remove unecessary comments (assume expert level)
- group by function
- complete/format Doxygen compatible comments (use groups)
- dont delete code
- add file revision in header to track modification, for this task, 'doxygen comments and structure' (skip if already done)
- save file when done (provide relative paths to fs:write tool)
- no need to lookup other files, the file content and path is provided !
- create an audit (security, performance) next to the source file (Markdown), if applicable, include relative path to source file, and the code of question, recommend fixes and improvements