Quelles règles StyleCop dois-je suivre lors de l'écriture d'une bibliothèque open source

Question

J'écris actuellement un wrapper open source pour un objet COM. Je viens d'installer StyleCop et de l'exécuter sur une partie de mon code, et comme je m'y attendais, j'ai lancé un tas d'avertissements (dont certains que j'aurais déjà dû faire, par exemple ajouter ceci à tous les appels et variables de méthode locale)

Combien de ces avertissements devrais-je essayer de réduire? Lesquelles seraient les meilleures lors de l'écriture d'une bibliothèque open source?

Answer 1

L'idée générale est de StyleCop: Tous :)

Plus d'options vous désactivez moins la valeur StyleCop. a dans l'application d'un format de code unique. Cela étant dit, si vous n'aimez pas certaines des options, alors certaines options sont préférables à aucune, inclure le fichier de paramètres StyleCop avec votre code et d'autres qui travaillent dessus peuvent alors utiliser les mêmes paramètres. Certains des paramètres peuvent sembler étranges au début si vous n'êtes pas familier avec StyleCop, mais après l'avoir utilisé pendant deux ans maintenant, je laisse toutes les options sur et notre équipe est assez content des résultats.

Je dirais aussi que si vous fournissez une bibliothèque ou un framework, utiliser FxCop peut être plus important que d'utiliser StyleCop.

Answer 2

La plupart des grands projets open source ont leurs propres directives de style. Par exemple, voici le Apache C Language Style Guide.

Pour commencer, je suggère de parcourir la FAQ pour le projet d'OS qui vous intéresse et de le prendre à partir de là.

De toute façon, je suis sûr qu'il y aura beaucoup de gens qui vous feront savoir rapidement si vous enfreignez les règles de style existantes dans une grande mesure! ;-)

Prenez garde à tous les avertissements, habituellement ils essaient de vous dire quelque chose d'utile. Ne finissez pas "programmation par coïncidence" (book excerpt) comme disent les programmeurs pragmatiques! Edit: Je ne me suis pas rendu compte que c'était votre propre nouveau projet OS. Ma faute. Quoi qu'il en soit, je vais flairer quelques projets d'OS similaires déjà existants et voir s'ils ont des guides de style. Certainement, consultez le livre complet de Code de Steve McConnell Code (Amazon link - aseptisé pour le script kiddie lien nazis qui errent dans ces salles). Ce que j'ai dit au sujet des avertissements et de la «programmation par coïncidence» s'applique toujours! (-:

HTH

acclamations,

Rob