You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update code to adhere to a common style guide and automated documentation system.
A consistent style for firmware usually should be enforced for large projects, in order for them to appear consistent. For C, a good template is the Linux style guide, however, it is common to make documented deviations where necessary.
It is also generally best practice that the firmware itself should be documented in a format compatible with auto-documentation tools such as Doxygen.
The text was updated successfully, but these errors were encountered:
Update code to adhere to a common style guide and automated documentation system.
A consistent style for firmware usually should be enforced for large projects, in order for them to appear consistent. For C, a good template is the Linux style guide, however, it is common to make documented deviations where necessary.
It is also generally best practice that the firmware itself should be documented in a format compatible with auto-documentation tools such as Doxygen.
The text was updated successfully, but these errors were encountered: