Do you know of anyway to annotate the decisions you make when doing a Cube project within the project itself?

[DHE]

When doing complex Cube projects often you have to make decisions about peripherals or pins or I/O configurations for specific, but not always obvious, reasons. If nothing else it would be nice to be able to attach some notes to a project so someone using it down the road can figure out why you did what you did.

[Pavel A.]

I often define custom symbols, because there's no other documented way to add custom info to a project.

These symbols, after code generation, become C #defines in main.h.

From there you can refer to them in other files.

Just some example....

#define EXT_UART 2 // use UART2 as external UART

#define EXT_UART_BAUDRATE 115200

#define HAS_BATTERY 1 // define if optional battery is assembled

-- pa

[DHE]

Thanks for your idea, that would work. It's too bad ST doesn't add a feature like that though -- you'd think it would be very easy to do. If they really wanted to make it more comprehensive they could let you document a specific item you chose to use or document a specific pin beyond just changing its name. But even just a blank page where you could write notes would be helpful.