Download C Program Style Guidelines
Transcript
C Program Style Guidelines 3.5. . Commenting other elements The following sections describe the typical elements you will need to comment in your programs. When you use other program elements, such as unions or structs, you should provide comments for them as well. The above guidelines should give you an idea of the level of documentation you should provide. Doxygen provides commands that let you customize your documentation. Develop your own style. Start simple and add as you need to. Remember to be as consistent as possible. 10