CCoding Style - Comment functions and Global data
From EdWiki
Comment functions and Global data
- Comment functions, Global variables, Constant definitions, fields in structures and anything else where a brief summery can aid understanding.
- Global variables have a tendency to crop up intermittently throughout a program; a comment serves as a remainder to be referred to as needed.
struct State { /* prefix + suffix list */ char* pref[NPREF]; /* prefix words */ suffix* suf; /* list of suffixes */ State* next; /* next in hash table */ };