Domanda breve
È necessario aggiungere i commenti dell'intestazione di funzione per gli accessor e i mutatori semplici ?
Esempio
u8 OBJ_get_state_x(void) {return obj.state_x;}
void OBJ_set_state_x(u8 x) {obj.state_x = x;}
Pensieri addizionali
L'oggetto (OBJ) nel suo complesso contiene una logica molto minimale (se presente). Il suo unico scopo è quello di mantenere lo stato di un sistema. Moduli aggiuntivi (come IO, COMM, DISPLAY, ecc ...) sanno tutti che l'oggetto è e contengono tutta la logica aziendale necessaria per guidare gli stati in OBJ.
Vorrei come per mantenere tutti gli accessors / mutators su una singola riga per rendere il file un po 'più leggibile e mettere semplicemente un'intestazione di blocco generico sopra tutti loro. Non so se questa è una pratica comune (o buona).
Si noti che tutti gli intervalli sono vincolati dal loro tipo. Se c'è uno stato speciale che ha un intervallo da 0 a 3, creo un enumerato typedef da usare come tipo (forzando quindi l'intervallo e rendendo il codice più leggibile IMO).