Embedded C Programming Style: Tutorial 15 - Comments

This tutorial highlights commenting styles: Single line comments, Multiple comments, Code commenting, Functions Documentation.

0:13 1.Comment non-obvious parts
1:25 2.Don't comment obvious parts
2:01 3.Single-line for generic comments
2:15 4.Multi-line for main, single-line for sub
3:51 5.Using if 0 endif
5:05 6.Todo
6:05 7.Doxygen
8:29 8.Function documentation in header file

[sillfsxa]

Good thing to know is that google and microsoft have great coding style documents. They are mostly used for softwares outside of the embedded world, but an embedded system engineer can exploit some of the good ones and use them for themselves. Having a coding style and be loyal to it can improve the performance of the programmers… that is a proven fact, but I don’t know why in embedded system, this fact is not taken serious!