Programming Organization

[Dave Scheck]

Originally Posted by Mike

Use double slash comments.

// Good
/* Bad */

Please not that C compilers are not required to support the double slash style comment. I would try to stay with the language specific comments for portability. If IFI were to change the RC and we needed a new compiler, there would be a chance that it wouldn't support the double slashes. In that case, you would be causing yourself to do extra work in porting the comments.

We actually just ran into this exact issue when teaching our software students. We designed labs and homework using the mcc18 compiler and mistakenly had double slash comments in some places. When we gave them the assignments, they were to use a gcc compiler. We found out quickly that gcc doesn't support the double slash and we had to go back and fix it.