Come scoprire gli stili di codifica accettati

https://stackoverflow.com/questions/232975

04-07-2019
|

Domanda

Dove leggere la (migliore prassi in) formattazione del codice sorgente, per le singole lingue, ovvero quali sono le convenzioni per nominare le variabili, ecc., per il rientro e dove posizionare le parentesi graffe, come e dove includere commenti, ecc.

Ad esempio per il libro di C Kernighan e Ritchie The C Programming Language e Guida allo stile di codifica del kernel Linux o Guida allo stile C ++ di Google e per Perl almeno perlstyle - Guida allo stile Perl .

Modifica: forse avrei dovuto chiedere " Come iniziare bene con gli stili di codifica " ;.

Soluzione

Non darei troppo a tali guide di stile. Sono un buon inizio, ma alla fine tu o il tuo team svilupperete i vostri stili di codifica.

EDIT: Rob Kam ha fatto un commento, che vuole scoprire di più su queste "convenzioni di partenza".

Questo è un buon punto. Ma per lo più ti unirai a progetti esistenti, progetti open source o commerciali e le persone che ci lavorano hanno già una convenzione sul codice. In un'azienda probabilmente esiste già una convenzione di codice. Se avvii un nuovo progetto, inizia con le convenzioni di un altro progetto che hai fatto in precedenza.

Se inizi davvero un nuovo progetto con una nuova lingua che non hai mai usato prima ... allora potresti iniziare con convenzioni di un'altra lingua che è in qualche modo simile (cioè per una nuova lingua originale puoi usare convenzioni da Java o Smalltalk) e modifica le convenzioni man mano che acquisisci esperienza per la nuova lingua. Quando ho iniziato a programmare in Java ho usato le mie convenzioni di codifica Pascal. Alcune convenzioni pasquali non funzionavano molto bene per Java, ma con il tempo ho abbandonato alcune vecchie convenzioni e ne ho sviluppate di nuove.

S.Lott ha avuto l'idea di esaminare un progetto open source scritto nella lingua che preferisci. Questa è una buona idea per ottenere alcuni suggerimenti su buone convenzioni. Srikanth ha avuto la buona idea di chiedere buone convenzioni qui su Stackoverflow. Un'ottima idea, perché con il tempo Stackoverflow diventerà un buon riferimento per le convenzioni di codifica in questo modo.

Altri suggerimenti

Ciò che è meglio di un libro è individuare il codice open source nella tua lingua preferita.

Piuttosto che un libro - il lavoro di alcuni autori ed editori - il codice sorgente di lavoro è un progetto della comunità che soddisfa gli standard della comunità altamente evoluti.

Quando mi viene chiesto dal cliente di aiutare con gli standard di codifica, preferisco trovare un buon progetto Open Source e fornire un breve documento sugli standard che dica "Fallo sembrare xxx". Un buon esempio che utilizzo per lo stile Java è il progetto Apache Ant .

Ognuno ha il proprio progetto di esempio open source preferito. Leggi un po 'di codice reale e funzionante e scegli un preferito. Emula quel progetto.

Vorrei usare Google per questo. Ad esempio, per cercare le Linee guida per la codifica Java, userò questa query o pubblica in Stack Overflow e chiedi quali sono le linee guida standard di codifica raccomandate per Java. È difficile indicare un'unica fonte per tutte le lingue.

Ti suggerirei di sceglierne uno per la tua azienda / progetto e di rispettarlo e assicurarti che sia un buon standard.

Consiglio vivamente di leggere Clean Code di zio bob preoccupato per problemi di stile del codice.

Ci sono tre buoni posti in cui cercare.

Libri popolari sulla lingua che stai utilizzando.
Progetti Open Source scritti nella tua lingua.
Programmi di utilità di tipo Checkstyle per la tua lingua.

Se usi uno strumento come Checkstyle o PMD, tieni presente che molte delle regole di "quotazione" fanno valere può essere controverso. Potrebbe essere utile controllare la documentazione per scoprire quali regole fare attenzione.

Microsoft ha un documento di riferimento con le loro convenzioni di codifica che possono essere utili da consultare, anche se non si utilizza C #. Oltre allo stile e alle convenzioni di base, i libri sulle migliori pratiche raccomandati da altri qui, come Clean Code , sono letture essenziali per la creazione di codice gestibile e leggibile che avrà senso per i futuri manutentori della tua base di codice.

Se si utilizza Visual Studio (e alcuni altri IDE moderni), le incoerenze di base con le convenzioni consigliate vengono automaticamente sottolineate (con suggerimenti su hover nelle ultime versioni di VS). In VS, se il tuo team desidera utilizzare standard diversi, basta aprire le proprietà del Progetto e modificare le impostazioni per " Analisi del codice " (ultima voce del menu a sinistra). Altro qui: Uso dei set di regole per raggruppare le regole di analisi del codice

Ciao e buona giornata a tutti

Beh, devo dire che dipende Dipende se lavori per un'azienda o se lavori per te;)

Se lavori per un'azienda, devi accettare lo stile di denominazione e altre regole

e per te, devi solo stabilire uno stile che tutti, compreso te stesso, possano immediatamente capire cosa e come

le parentesi e altre sono la tua strada

ma come hai detto ci sono singole lingue, quindi hanno le proprie regole

e come Mnementh ha detto che ogni squadra ha un modo di codificare forse in modo rigoroso o libero

Questo è tutto con non più .... ciao ciao

Esistono le Guide di stile C e C ++ , una breve pagina di collegamenti alle guide di stile, alle regole di codifica e alle discussioni di USENET, gestite da Christopher Lott.

Se sei uno sviluppatore PHP non perdere queste due guide:

Autorizzato sotto: CC-BY-SA insieme a attribuzione

Non affiliato a StackOverflow