Il mio manager vuole che completiamo un elenco di controllo per una definizione di Fine, in cui gli elementi della checklist sono brevi.
Qual è un buon modo per dire "codice è chiaro" che potrebbe implicare meglio che il codice sia comprensibile da un ingegnere del software ragionevole, ben organizzato e adeguatamente commentato e documentato? (Se lo dico esplicitamente, è troppo lungo.)
Se desideri un codice comprensibile da qualcun altro nel tuo team, chiedi a qualcun altro del tuo team di esaminarlo e dillo.
Queste sono chiamate recensioni di codice e una parte ampiamente prevista della definizione di fatto.
"Is it organized?"
"Is it commented?"
Quindi diventa parte della rubrica / criteri / criteri di Revisione del codice, che di solito può essere più flessibile nel tempo e per squadra.
Il giudizio "il codice è chiaro" non è oggettivamente misurabile e quindi problematico. Invece:
Se la chiarezza del codice è importante per il tuo team, inizia a fare revisioni del codice (funziona perfettamente con un flusso di lavoro basato su richiesta di pull). La definizione di fatto include quindi "il codice è stato rivisto". Vi è il rischio che una revisione del codice apporti solo modifiche di gomma, ma questo è un problema separato.
Usa strumenti di controllo automatico dello stile e di sfilacciamento ed eseguili come parte della tua pipeline CI. Quindi, la tua definizione di fatto include "il codice costruisce con successo". Questi strumenti di controllo dello stile possono essere utilizzati per applicare in modo efficace una guida di stile, sebbene alcuni aspetti di una guida di stile non possano essere ragionevolmente automatizzati. Le cose che sono facili da automatizzare sono la formattazione, le convenzioni di denominazione e la documentazione.
Se non si dispone già di una guida di stile o di convenzioni di codifica, l'aggiunta di uno strumento potrebbe comportare numerosi avvisi errati. Inizialmente potrebbe essere meglio iniziare con una configurazione minima e aggiungere regole più severe su richiesta (e occasionalmente inserire alcuni refactoring per rendere il codice esistente conforme a più regole).
Leggi altre domande sui tag development-process agile scrum