Esiste uno standard di settore per strutturare codice e commenti?

Naviga le tue risposte
3

Ho lavorato con un certo numero di team di professionisti e sembra che la struttura del codice di classe varia da altamente organizzata a completamente disordinata. Ho fatto recentemente un progetto con lo stato della California e hanno richiesto l'utilizzo di regioni specifiche nel mio codice VB, insieme ai commenti XML incorporati per gli auto-documenti. Era molto strutturato, ma in molte classi c'era più commenti rispetto al codice. Sono curioso di sapere se esiste uno standard di settore per la struttura del codice e i commenti.

Modifica

Forse sarebbe una domanda più appropriata, quali sono alcune buone pratiche da adottare per la leggibilità e la manutenzione e perché? Voglio impostare presto buone abitudini di codifica.

    
posta Ken Anderson 28.10.2011 - 19:36
fonte

1 risposta

5

Non esistono standard esistenti in tutti i settori che governano la struttura del codice. Dubito che ogni settore abbia standard di codifica per tutto il settore che trattano commenti, struttura dei file e organizzazione del progetto.

La cosa più vicina che potresti trovare sarebbe MISRA C , che sono linee guida prodotte dalla Motor Reliability Association di Motor Industry per garantire un codice sicuro, portatile e affidabile nel codice che viene eseguito nei sistemi integrati nelle automobili. Tuttavia, poiché non lavoro nel settore automobilistico, non ho mai dovuto occuparmi di questo.

In genere, la struttura del codice e le linee guida vengono eseguite a livello organizzativo o di progetto, non tra le organizzazioni o all'interno dei settori. Se vuoi esempi di come scrivere un codice buono, pulito e leggibile, ti suggerisco di consultare il codice completo di Steve McConnell , Andy Hunt e il programmatore Pragmatico di Dave Thomas , Diomidis Spinellis's Code Quality: The Open Source Perspective e Robert" Uncle Bob "Martin's Pulisci codice: un manuale di abilità software agile - questi sono i libri canonici su come scrivere il miglior codice possibile, indipendentemente dalla lingua o dalla piattaforma. Molte lingue hanno anche linee guida di stile, come Convenzioni del codice Oracle per il linguaggio di programmazione Java , che possono servire come base per un'organizzazione o le regole di stile del codice del progetto.

    
risposta data 28.10.2011 - 19:42
fonte

Leggi altre domande sui tag

Dovresti testare indirettamente i metodi privati dai test dei metodi pubblici? Lo sviluppatore dovrebbe essere coinvolto nella configurazione dei dati di test in ambiente QA e UAT?