Mi rendo conto che il formato di "commento di intestazione" varia da programmatore a programmatore, ma quale sarebbe un esempio di un commento di intestazione "buono"?
Mi rendo conto che il formato di "commento di intestazione" varia da programmatore a programmatore, ma quale sarebbe un esempio di un commento di intestazione "buono"?
Per quanto riguarda lo stile di formattazione, la consistenza è la cosa più importante da perseguire. Assicurati che ogni commento di definizione di classe cerchi come ogni altro, ogni commento di metodo assomigli a tutti gli altri, ecc.
Quindi, se stai modificando il codice esistente , assicurati di seguire il loro stile di formattazione. I commenti (e, in una certa misura, il codice) dovrebbero apparire come se una sola persona avesse lavorato al file. Se stai iniziando un nuovo progetto, scegli un formato di stile e rimani fedele.
Luoghi per iniziare a cercare:
Leggi altre domande sui tag coding-style code-formatting c++ comments headers