24. Appendix B — Change Log

Updated 2024-11-06:

Broke down original document into chapters.

Updated 2024-10-24:

Added summary of naming in general: functions, commands and variables. Added commenting priorities. Converted to reStructuredText.

Updated 2024-05-23:

Added ‘4b’ as variable type prefix for 4-bit array types.

Updated 2024-05-17:

Added memory name prefix for variables that are defined as __attribute__((coherent)) (a.k.a. CACHE_ALIGN). Also added reminders about exceptions to variable-naming rules.

Updated 2024-04-10:

Added example of missing braces on an IF statement causing dangerously ambiguous code.

Updated 2024-03-19:

Adding item 23 in the Quickstart Rules section. Also added guidance on using back-quotes in comments.

Updated 2024-03-15:

Added overall sourcecode patterns where functions at the bottom of a source code file, which in turn call functions above them, with utility functions and queries mostly occurring at the top.

Updated 2023-08-31:

Merged some standards with LVGL coding style. These were already being used, but had not been stated explicitly yet.

Updated 2021-03-10:

Added quickstart rules for Embedded C Systems, and supplemented rules with some rules that have been in use for some time, but not written down yet.

Updated 2021-03-06:

Review/update/refinement.

Updated 2021-03-05:

Added introductory/orientation material. Moved DbC details to Appendix A.

Updated 2021-02-24:

Added .NET namespace coding guidelines.

Updated 2020-07-09:

Added link to Wikipedia article on refactoring with first use of the term.

Updated 2018-03-15:

Added ‘v’ and ‘q’ type prefixes for Vector and Queue respectively.

Updated 2017-12-06:

Added “Senior Policy” section below “Impetus” section.

Updated 2017-06-28:

Clarification on enumeration differences between C and VB.NET.

Updated 2017-06-12:

Added VB.NET Coding Guidelines

Updated 2016-12-14:

Updated 2016-05-16:

Doxygen Support in Documentation

Updated 2016-05-04:

Updated 2015-11-25:

Updated 2012-11-28: