編寫開源庫時應遵循哪種StyleCop規則

Question

我目前正在爲COM對象編寫一個開源包裝器。我剛剛安裝了StyleCop並運行它對我的一些代碼，並且正如我預期的那樣，它會拋出一大堆警告（其中一些應該已經做過了，例如，將「this」添加到所有本地方法調用和變量）

我應該嘗試減少多少這些警告？編寫開源庫時哪些是最好的？

Answer 1

用了StyleCop的總體思路是：所有這些:)

的更多選擇你關掉價值不大了StyleCop。已經實施了一種真正的代碼格式。話雖如此，如果您不喜歡某些選項，那麼某些選項比沒有選項好，請將StyleCop設置文件與您的代碼一起使用，然後其他人使用相同的設置。

如果您對StyleCop不熟悉，但是已經使用了兩年，我將所有選項都留下，我們的團隊對結果非常滿意，但一些設置看起來可能很奇怪。

我還會說，如果您提供的庫或框架使用FxCop可能比使用StyleCop更重要。

Answer 2

大多數大型開源項目都有自己的風格指南。例如，這裏是Apache C Language Style Guide。

作爲一個開始，我建議您抓取您感興趣的操作系統項目的常見問題解答，並從那裏獲取它。

無論如何，我敢肯定會有很多人會很快讓你知道，如果你打破了現有的任何風格規則！ ;-)

注意所有的警告，通常他們試圖告訴你一些有用的東西。不要像語言程序員所說的那樣，通過巧合來編程（book excerpt）！

編輯：我沒有意識到這是你自己的新的OS項目。我的錯。無論如何，我會嗅探一些類似的現有OS項目，看看他們是否有任何風格指南。當然，看看史蒂夫麥康奈爾的書代碼完整（Amazon link - 消毒腳本kiddie鏈接納粹漫遊這些大廳）。

我說的關於警告和「巧合編程」仍然適用！ （ - ：

HTH

歡呼聲，

羅布