Quali regole StyleCop dovrei seguire quando scrivo una libreria open source [chiuso]

Question

Attualmente sto scrivendo un wrapper open source per un oggetto COM. Ho appena installato StyleCop ed eseguito su parte del mio codice e, come mi aspettavo, ha generato un carico di avvisi (alcuni dei quali avrei dovuto fare già ad esempio aggiungendo " questo. & Quot; a tutte le chiamate e le variabili di metodo locali )

Quanti di questi avvertimenti dovrei provare a ridurre? Quali sarebbero i migliori quando si scrive una libreria open source?

Answer 1

L'idea generale con StyleCop è: tutti loro :)

Più opzioni disattivi, meno valore ha StyleCop nel far rispettare un formato di codice one-true. Detto questo, se non ti piacciono alcune delle opzioni allora alcune opzioni sono meglio di nessuna, includi il file delle impostazioni di StyleCop con il tuo codice e altri che ci lavorano possono quindi usare le stesse impostazioni.

All'inizio alcune impostazioni potrebbero sembrare strane se non hai familiarità con StyleCop, ma dopo averlo usato per due anni lascio tutte le opzioni attive e il nostro team è abbastanza soddisfatto dei risultati.

Direi anche che se stai fornendo una libreria o un framework che utilizza FxCop potrebbe essere più importante dell'uso di StyleCop.

Answer 2

La maggior parte dei grandi progetti open source ha le proprie linee guida di stile. Ad esempio, ecco la Guida allo stile del linguaggio Apache C .

Per iniziare, suggerisco di trascinare le FAQ per il progetto OS che ti interessa e di prenderlo da lì.

Ad ogni modo, sono sicuro che ci saranno molte persone che ti faranno sapere rapidamente se stai infrangendo le regole di stile esistenti in grande stile! ; -)

Fai attenzione a tutti gli avvisi, di solito stanno cercando di dirti qualcosa di utile. Non finire "programmazione per coincidenza" ( estratto del libro ) come dicono i programmatori pragmatici!

Modifica: non mi ero reso conto che questo era il tuo nuovo progetto OS. Colpa mia. Ad ogni modo, mi piacerebbe annusare alcuni progetti OS già esistenti simili e vedere se hanno delle guide di stile. Sicuramente, controlla il libro di Steve McConnell Codice completo ( Link Amazon - sanitized for the script kiddie link nazis che vagano per queste sale).

Quello che ho detto su avvisi e "programmazione per coincidenza" vale ancora! (-:

HTH.

applausi,

Rob