Perché le guide di stile non includono spiegazioni più lunghe perché qualcosa dovrebbe essere fatto in un modo particolare? [chiuso]

Question

Perché le guide di stile non includono spiegazioni più lunghe perché qualcosa dovrebbe essere fatto in un modo particolare? [chiuso]

#1 da (2 voti)
#2 da (1 voti)

0

Quando leggo le guide di stile di codifica, come la Guida di stile Javascript AirBnB ho appena realizzato che queste spesso non fornisce spiegazioni più profonde perché qualcosa dovrebbe essere fatto in un modo particolare.

Al massimo ci sono brevi affermazioni, raramente link ad es. "Non funzionerà in IE8. Ulteriori informazioni ."

Perché è così? Almeno un elenco di riferimenti o un collegamento a una versione annotata sarebbe più utile, ad es. ai nuovi dipendenti che devono lavorare con una guida di questo tipo.

Ci sono dei controesempi notevoli, per qualsiasi lingua? (Impossibile leggerli tutti)

Considererei queste guide di stile come "documenti viventi" e nel tempo mi aspetterei che diventassero versioni più prolisse con molti link, conservando le lezioni apprese e documentando come evitare oscuri casi limite.

Va bene iniziare con un documento bare-bones. È più facile da leggere. ma non dovrebbe evolvere questi documenti, una versione più lunga che indica una guida di stile più "matura"?

coding-style

posta knb 14.11.2015 - 20:36

fonte

2 risposte

Leggi altre domande sui tag coding-style

Che cos'è un algoritmo leggibile per selezionare un acquirente casuale in base a ciò che hanno acquistato? Devo utilizzare: un evento più abbonati o più eventi più abbonati

score 2 · Answer 1

In primo luogo, una guida di stile è né un tutorial né un libro di testo per l'apprendimento delle migliori pratiche. Se desideri spiegazioni esaustive, devi leggere un libro come "Codice completo" o qualcosa di simile. Ma non è niente che tu abbia letto in una o due ore.

Inoltre, molti dettagli nelle guide di stile sono supponenti e alcune regole sono lì solo per imporre la coerenza all'interno di una squadra. Spesso non c'è nulla di meglio di una "spiegazione più profonda", a volte è solo "la maggior parte dei nostri sviluppatori ha votato per nomi di funzioni che iniziano con lettere maiuscole, ecco perché abbiamo scelto questo stile".

score 1 · Answer 2

Dove lavoro, le guide di stile del codice utilizzate / definite sono il risultato (essenza) delle precedenti discussioni tra sviluppatori. Di solito nessuno è interessato a riprodurre discussioni più lunghe, ma è interessato a documentarne l'esito. In genere queste linee guida sono destinate al nuovo personale. Di solito non crei una nuova styleguide, quando assumi un nuovo membro del team, poiché le discussioni richiedono molto tempo e non conducono così tanto a nuove conoscenze.

Se hai bisogno di una conoscenza approfondita del motivo per cui una regola particolare viene creata / utilizzata devi chiedere agli autori stessi o temo che tu debba ricercare da solo perché è stata creata una regola particolare.