Ci sono delle norme di base e le pratiche per rendere il codice leggibile?

Question

In particolare rendendo HTML, Java e Python più leggibile? Qualcuno ha suggerimenti per questo studente di programmazione?

Answer 1

1. Usa involucro coerente e la denominazione.

2. Utilizzare le schede (e staffe dove disponibile) per fornire un flusso visivo.

3. utilizzare i commenti che spiegano cosa sta succedendo concettualmente e tecnicamente. (Per esempio, // Abbiamo un utente valido? Non // Controllare che ID_utente non è -1)

Sono sicuro che alcuni sviluppatori più esperti avranno più suggerimenti, ma questi sono i miei top 3.

Answer 2

indentazione corretta e informativi commenti.

Answer 3

Usa indentazione, commenti e convenzioni di codifica (per Python controllare le PEP8 )

Answer 4

assicurarsi che il codice è ben strutturato (corretta indentazione, righe vuote a sezioni separate di codice, ecc) e l'uso standard, coerente, e completamente nominato (piuttosto che abbreviati incomprensibili) i nomi delle variabili.

Altri suggerirei di usare i commenti appropriati. Avrei abbastanza in disaccordo. Se il codice è ben strutturato e ben variabili nome, quindi i commenti sarebbe solo ingombrare le cose. L'eccezione alla regola di essere quando si deve fare qualcosa contro-intuitivo per aggirare un bug da qualche altra parte (ho dovuto ricorrere a questo nel codice WCF e Entity Framework in passato).

Answer 5

Provate a leggere il codice a voce alta (o almeno nella tua testa).

Answer 6

Date un'occhiata a questo libro: codice pulito: un manuale di artigianato agile del software . Si tratta solo di rendere il codice leggibile e comprensibile.

Answer 7

Un consiglio è di non essere pigri con i nomi. Ad esempio, se si dispone di una classe Java che è un'implementazione dell'interfaccia Transformer, e trasforma String a Date, non esitate a chiamare il StringToDateTransformerImpl classe.

Answer 8

Bene, si può sempre utilizzare il "test ignoranti". Mostra il tuo codice per qualcuno che sa assolutamente nulla di programmazione. Se riesce a vedere più o meno cosa fa una funzione, il codice è probabilmente leggibile.

Answer 9

Una corretta indentazione durante la scrittura di codice HTML può essere un salvagente, soprattutto quando si sta interagendo con qualsiasi tipo di elementi annidati. Basta essere coerente con il rientro ed essere sicuri di aggiornare le linee circostanti quando si sposta o si elimina un elemento frastagliata. Questo rende molto più facile per aggiornare la pagina, come il livello di rientro darà un indizio su dove ci si trova nella pagina senza ricorrere a una sorta di Ctrl + F manovra.

E 'anche interessante notare che se si sta utilizzando i CSS in combinazione con HTML, una corretta denominazione è fondamentale! Si migliorerà il flusso di lavoro e la leggibilità del codice.

Sono anche un grande fan di indentazione, spaziatura e commenti quando si scrive "reale" (Java, Python, C, ecc) del codice. Mi chino verso (x + 1) sopra (x + 1) perché io personalmente penso che fa una grande differenza nella leggibilità. spazio I out calchi, incrementi, ecc e catturano la mia attenzione molto più facilmente. Essere coerenti con il tuo stile staffa / indentazione, e commentare liberamente - ricordate, ri-scrittura di un nome di metodo non è un commento